We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent e848449 commit c172a46Copy full SHA for c172a46
1 file changed
README.md
@@ -1,3 +1,27 @@
1
# sciclops_module
2
3
A MADSci Node module for interfacing with the Hudson Robotics Sciclops Platecrane.
4
+
5
+## Installation and Usage
6
7
+### Python
8
9
+```bash
10
+# Create a virtual environment named .venv
11
+python -m venv .venv
12
+# Activate the virtual environment on Linux or macOS
13
+source .venv/bin/activate
14
+# Alternatively, activate the virtual environment on Windows
15
+# .venv\Scripts\activate
16
+# Install the module and dependencies in the venv
17
+pip install .
18
+# Run the environment
19
+python -m sciclops_rest_node --host 127.0.0.1 --port 2000
20
+```
21
22
+### Docker
23
24
+We provide a `Dockerfile` and example docker compose file (`compose.yaml`) to run this node dockerized.
25
26
+There is also a pre-built image avaible as `ghcr.io/ad-sdl/sciclops_module`.
27
0 commit comments