Skip to content

Commit a6e367d

Browse files
Merge branch 'madsci'
2 parents d597456 + 1051bcb commit a6e367d

13 files changed

Lines changed: 2285 additions & 222 deletions

File tree

.github/rename.sh

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

.github/workflows/rename.yml

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

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,3 +158,7 @@ cython_debug/
158158
# and can be added to the global gitignore or merged into this file. For a more nuclear
159159
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160160
#.idea/
161+
162+
.pdm-python
163+
164+
.vscode/

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22

33
This is the repository for Barty, "the bartending robot", a low cost liquid consumable manager developed at Argonne National Lab's Rapid Prototyping Lab.
44

5+
An example definition file can be found at `definitions/barty.node.yaml` and a description of the node's capabilities can be found at `definitions/barty.node.info.yaml`
6+
57
## Installation and Usage
68

79
### Python
810

11+
Note: your user must be in the same group as the `/dev/gpiomem` device (likely either `gpio` or `dialout`), in order to access the Raspberry Pi's GPIO pins. Otherwise, you must run the node as root (not recommended)
12+
913
```bash
1014
# Create a virtual environment named .venv
1115
python -m venv .venv
@@ -16,5 +20,5 @@ source .venv/bin/activate
1620
# Install the module and dependencies in the venv
1721
pip install .
1822
# Start the node
19-
python src/barty_module --definition <path/to/definition.yaml>
23+
python -m barty_node --definition <path/to/definition.yaml>
2024
```

0 commit comments

Comments
 (0)