Skip to content

Commit 5523b57

Browse files
committed
explain size_{x,y,z} and name
1 parent 266ac21 commit 5523b57

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/resources/introduction.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ The relation between resources is modelled by a tree, specifically an [_arboresc
1212

1313
## Defining a simple resource
1414

15-
The simplest way to define a resource is to subclass {class}`pylabrobot.resources.resource.Resource` and define the `name` and `size_x`, `size_y` and `size_z` attributes. Here's an example of a simple resource:
15+
The simplest way to define a resource is to subclass {class}`pylabrobot.resources.resource.Resource` and define the `name` and `size_x`, `size_y` and `size_z` attributes.
16+
17+
The size attributes are in millimeters and define the dimensions of the resource as a cuboid. This the complete outer bounding box of the resource. The `name` attribute is a unique identifier for the resource, and it can be used to reference the resource in protocols and programs.
18+
19+
Here's an example of a simple resource:
1620

1721
```python
1822
from pylabrobot.resources import Resource

0 commit comments

Comments
 (0)