You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quickstart.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,10 +25,10 @@ docker-compose up
25
25
```
26
26
27
27
## Running with Python
28
-
First, use your favourite tool to create and activate a new python environment with python 3.11 or higher.
28
+
First, use your favorite tool to create and activate a new Python environment with Python 3.11 or higher.
29
29
For example with pyvenv on linux:
30
30
```bash
31
-
python -m venv labautomation
31
+
Python -m venv labautomation
32
32
source labautomation/bin/activate
33
33
```
34
34
3. Install all necessary packages:
@@ -59,7 +59,7 @@ Setup: Run and follow the instructions to create an admin login to Django. On Wi
59
59
60
60
Fill the database: Run
61
61
```bash
62
-
python scripts/add_lab_setup_to_db.py
62
+
Python scripts/add_lab_setup_to_db.py
63
63
```
64
64
This adds the lab setup as described in platform_config.yml to the database.
65
65
Rerun this script after you customized the config file.
@@ -125,17 +125,17 @@ example processes.
125
125
5. Click on "Add Containers to DB". This creates entries for all labware in that process in the positions described in
126
126
the process in case there isn't already labware. Existing labware is considered to belong to that process. You can
127
127
see all present labware in the database view which updates automatically.
128
-
6. (Optional) Click on "Schedule Process" to get a predicted schedule. It will appear at gantt chart.
128
+
6. (Optional) Click on "Schedule Process" to get a predicted schedule. It will appear the Gantt chart.
129
129
7. Click on "Start Process". This will update the schedule and will execute steps accordingly.
130
130
You can monitor the progress in the orchestrator GUI and the labware movements in the database view.
131
131
132
132
### Things to observe during the process
133
133
While the process runs you can observe different features of our framework.
134
134
135
135
1. Live updates of the process in the orchestrator:
136
-
1. The gantt chart has a moving bar of where in time you currently are
136
+
1. The Gantt chart has a moving bar of where in time you currently are
137
137
2. Process step nodes in the graph turn yellow while they are being executed and green when they are finished. Pink means there was an error.
138
-
3. If a barcode for any labware equipment is read or assigned, it is shown in the gantt chart
138
+
3. If a barcode for any labware equipment is read or assigned, it is shown in the Gantt chart
139
139
2. Live updates of the database
140
140
1. In the database view (which auto-reloads to reflect modifications), all labware is listed with its barcode and current position.
141
141
2. The [admin view](http://127.0.0.1:8000/admin/) of the database allows you to see the results and the labware involved, as well as to change the duration and starting time of each step. The credentials are the ones you chose during the installation process for the superuser.
0 commit comments