Build Documentation

Build Documentation

Clone

First, the project needs to be downloaded to your local machine. You can clone the repository from Github either by using an HTTPS or SSH link.

HTTPS Link

git clone https://github.com/amosproj/amos2024ss06-health-ai-framework.git

SSH Link

git clone git@github.com:amosproj/amos2024ss06-health-ai-framework.git

Build Process

Our project uses Python 3.10 as a prerequisite. Because we use python, there is no building. We utilise the package and dependency manager called PDM. To install the manager, create a virtual environment and download the needed dependencies, you can use the following commands:

# Install pdm 
pip install pdm
# Install the dependencies in a virtual environment
pdm install

All project dependencies are stored in a file pyproject.toml. The file also describes which particular versions of each library are used. Our toml file also defines scripts that can be run with PDM. More detailed information about different components can be found in the design documentation. For example you can run the config and orchestrator components with:

pdm build-config
pdm run-orchestrator

Deploy

After cloning the repository, if you want to run the project in a container instead of on your local machine, you can set it up with the container tool Singularity (now called Apptainer).

# Build the Singularity container
singularity build Apptainer.sif Apptainer.def
# Opens a shell within the container to interact with its environment
singularity shell Apptainer.sif

In the shell, run the build commands from the previous section about building.