Installation#

EOS should be installed on a capable computer in the laboratory. We recommend a central computer that is easily accessible.

Note

If EOS will be connecting to other computers to run automation, then you must ensure that the computer where EOS is installed has bi-directional network access to the other computers.

We strongly recommend that the laboratory has its own isolated network for security and performance reasons. See infrastructure setup for more information.

EOS also requires a PostgreSQL database and a MinIO object storage server. We provide a Docker Compose file that can set up all of these services for you.

1. Install uv#

uv is used as the dependency manager for EOS. It installs dependencies extremely fast.

See the uv documentation for more information or if you encounter any issues.

Linux/Mac

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

2. Clone the EOS Repository#

git clone https://github.com/UNC-Robotics/eos

3. Make a Virtual Environment#

We create a virtual environment to isolate the dependencies of EOS from the rest of the system.

cd eos # Navigate to the cloned repository
uv venv
source .venv/bin/activate

4. Install Dependencies#

Navigate to the cloned repository and run:

uv sync