Development

Development

Clone the repository

git clone https://github.com/USI-FMAA/digital_casting_system.git
# Alternately
git clone --recurse-submodules https://github.com/USI-FMAA/digital_casting_system.git

# if the repository is already cloned
cd digital_casting_system
git submodule update --init --recursive

Update the submodules

# Update the submoudles
git submodule update --remote --merge
git pull --recurse-submodules


# Alternately
git submodule init
cd external_controllers
git checkout master # checkout the lastest version
git pull

# Alternately way
git submodule foreach git pull origin master

Setup the environment

With UV package manger (super fast package management build by rust)

Install UV

# On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh

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

uv --version

Create virtual environment

UV

uv venv --python 3.12
source .venv/bin/activate
uv pip install -e .

# optional
uv pip install '.[dev]' # install the development dependencies
uv pip install '.[docs]' # install the documentation dependencies

Alternately with Anaconda package manager

# Create the environment and activate it
conda create --prefix ./.env python=3.10

# Install dependencies
conda activate ./.env
pip install -r requirements.txt

# Install Compas framework
pip install compas
pip install git+git://github.com/WeiTing1991/compas_rrc.git@main