Skip to content

Commit 266ac21

Browse files
committed
move pedestal_size_z to PlateHolder in docs
1 parent d131018 commit 266ac21

File tree

5 files changed

+28
-29
lines changed

5 files changed

+28
-29
lines changed

docs/resources/carrier/plate-carrier/plate_carrier.ipynb

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -234,27 +234,6 @@
234234
"source": [
235235
"await lh.move_resource(my_plate, my_plate_carrier[2])"
236236
]
237-
},
238-
{
239-
"cell_type": "markdown",
240-
"metadata": {},
241-
"source": [
242-
"## Pedestal z height\n",
243-
"\n",
244-
"> ValueError(\"pedestal_size_z must be provided. See https://docs.pylabrobot.org/resources/plate_carriers.html#pedestal_size_z for more information.\")\n",
245-
"\n",
246-
"Many plate carriers feature a \"pedestal\" or \"platform\" on the sites. Plates can sit on this pedestal, or directly on the bottom of the site. This depends on the pedestal _and_ plate geometry, so it is important that we know the height of the pedestal.\n",
247-
"\n",
248-
"The pedestal information is not typically available in labware databases (like the VENUS or EVOware databases), and so we rely on users to measure and contribute this information.\n",
249-
"\n",
250-
"Here's how you measure the pedestal height:\n",
251-
"\n",
252-
"![Pedestal height measurement](/resources/img/pedestal/measure.jpeg)\n",
253-
"\n",
254-
"Once you have measured the pedestal height, you can contribute this information to the PyLabRobot Labware database. Here's a guide on contributing to the open-source project: [\"How to Open Source\"](/contributor_guide/how-to-open-source.md).\n",
255-
"\n",
256-
"For background, see PR 143: [https://github.com/PyLabRobot/pylabrobot/pull/143](https://github.com/PyLabRobot/pylabrobot/pull/143)."
257-
]
258237
}
259238
],
260239
"metadata": {

docs/resources/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,6 @@ container/container
129129
deck/deck
130130
itemized-resource/itemized-resource
131131
resource-holder/resource-holder
132-
resource-holder/plate-holder
133132
plate-adapter/plate-adapter
134133
resource-stack/resource-stack
135134
```
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# PlateHolder
2+
3+
TODO: write a tutorial
4+
5+
See :class:`~pylabrobot.resources.PlateHolder` for the API reference.
6+
7+
## Pedestal z height
8+
9+
> ValueError("pedestal_size_z must be provided. See https://docs.pylabrobot.org/resources/resource-holder/plate-holder.html#pedestal_size_z for more information.")
10+
11+
Many plate carriers feature a "pedestal" or "platform" on the sites. Plates can sit on this pedestal, or directly on the bottom of the site. This depends on the pedestal _and_ plate geometry, so it is important that we know the height of the pedestal.
12+
13+
The pedestal information is not typically available in labware databases (like the VENUS or EVOware databases), and so we rely on users to measure and contribute this information.
14+
15+
Here's how you measure the pedestal height:
16+
17+
![Pedestal height measurement](/resources/img/pedestal/measure.jpeg)
18+
19+
Once you have measured the pedestal height, you can contribute this information to the PyLabRobot Labware database. Here's a guide on contributing to the open-source project: ["How to Open Source"](/contributor_guide/how-to-open-source.md).
20+
21+
For background, see PR 143: [https://github.com/PyLabRobot/pylabrobot/pull/143](https://github.com/PyLabRobot/pylabrobot/pull/143).

docs/resources/resource-holder/plate-holder.rst

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/resources/resource-holder/resource-holder.ipynb

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@
1414
"`ResourceHolder` ensures that the child resource is placed correctly inside the\n",
1515
"holder. When the holder is rotated the child resource is automatically shifted\n",
1616
"so that its local origin lines up with the correct corner of the holder. This\n",
17-
"avoids having to manually adjust coordinates for every rotation."
17+
"avoids having to manually adjust coordinates for every rotation.\n",
18+
"\n",
19+
"For `ResourceHolder`s that hold plates, use the `PlateHolder` subclass instead.\n",
20+
"\n",
21+
"```{toctree}\n",
22+
"plate-holder\n",
23+
"```"
1824
]
1925
},
2026
{

0 commit comments

Comments
 (0)