Welcome to the development guide for the NDIF
project! This document explains how to set up a development environment, install dependencies, and get started with contributing to the project.
- Python 3.10
- Docker
- Docker Compose
If you haven't already, install Conda by downloading and installing Anaconda or Miniconda from the official Conda website.
Fork the NDIF repository to your local machine. Create a new Conda virtual environment for the NDIF
project with required dependencies. Replace ndif-dev
with your desired environment name.
conda env create --name ndif-dev -f requirements.yml
conda activate ndif-dev
- Build the base environment
First, build the base environment using the make build_base
command. This will set up the base images.
make build_base
- Build the service
Next, build the service using the make build_service
command.
make build_service
- Start the development containers
After building the base environment and the service, start the NDIF docker containers.
make up-dev
- Inspect server status
After building the NDIF containers, you can check the docker logs to verify the services are running correctly.
docker logs ndif-api-dev-1
You should expect to see a message like Application startup complete.
in the api service log.
- Run tests
We can now execute the test which will send 3 nnsight requests to the api service running inside the local container.
python dev-test.py