Development Guide

Development Prerequisites

Have or create a GitHub account.

Make shure all the source installation prequistes are installed. See the installation guideline for a detailed list of tools.

Under Linux the make tool should be installed as we have a lot of pre-fabricated commands for it.

Install your favorite editor or integrated development environment (IDE):

Step 1 – Fork the Repository

Fork the EOS repository to your GitHub account.

Clone your fork locally and add the EOS upstream remote to track updates.

git clone https://github.com/<YOURUSERNAME>/EOS.git
cd EOS
git remote add eos https://github.com/Akkudoktor-EOS/EOS.git

Replace <YOURUSERNAME> with your GitHub username.

Step 2 – Development Setup

This is recommended for developers who want to modify the source code and test changes locally.

Step 2.1 – Create a Virtual Environment

python -m venv .venv
.venv\Scripts\pip install --upgrade pip
.venv\Scripts\pip install -r requirements-dev.txt
.venv\Scripts\pip install build
.venv\Scripts\pip install -e .

Step 2.2 – Activate the Virtual Environment

.venv\Scripts\activate.bat

Step 2.3 - Install pre-commit

Our code style and commit message checks use pre-commit.

pre-commit install
pre-commit install --hook-type commit-msg --hook-type pre-push

Step 3 - Run EOS

Make EOS accessible at http://localhost:8503/docs and EOSdash at http://localhost:8504.

Option 1 – Using Python Virtual Environment

python -m akkudoktoreos.server.eos

To have full control of the servers during development you may start the servers independently - e.g. in different terminal windows. Don’t forget to activate the virtual environment in your terminal window.

Note

If you killed or stopped the servers shortly before, the ports may still be occupied by the last processes. It may take more than 60 seconds until the ports are released.

You may add the --reload true parameter to have the servers automatically restarted on source code changes. It is best to also add --startup_eosdash false to EOS to prevent the automatic restart interfere with the EOS server trying to start EOSdash.

python -m akkudoktoreos.server.eosdash --host localhost --port 8504 --log_level DEBUG --reload true

python -m akkudoktoreos.server.eos --host localhost --port 8503 --log_level DEBUG --startup_eosdash false --reload true

Option 2 – Using Docker

Step 3.1 – Build the Docker Image

docker build -t akkudoktoreos .

Step 3.2 – Run the Container

docker run -d `
  --name akkudoktoreos `
  -p 8503:8503 `
  -p 8504:8504 `
  -e OPENBLAS_NUM_THREADS=1 `
  -e OMP_NUM_THREADS=1 `
  -e MKL_NUM_THREADS=1 `
  -e EOS_SERVER__HOST=0.0.0.0 `
  -e EOS_SERVER__PORT=8503 `
  -e EOS_SERVER__EOSDASH_HOST=0.0.0.0 `
  -e EOS_SERVER__EOSDASH_PORT=8504 `
  --ulimit nproc=65535:65535 `
  --ulimit nofile=65535:65535 `
  --security-opt seccomp=unconfined `
  akkudoktor-eos:latest

Step 3.3 – Manage the Container

docker logs -f akkudoktoreos
docker stop akkudoktoreos
docker start akkudoktoreos
docker rm -f akkudoktoreos

For detailed Docker instructions, refer to Installation Guideline

Step 4 - Create the changes

Step 4.1 - Create a development branch

git checkout -b <MY_DEVELOPMENT_BRANCH>

Replace <MY_DEVELOPMENT_BRANCH> with the development branch name. The branch name shall be of the format (feat|fix|chore|docs|refactor|test)/[a-z0-9._-]+, e.g:

  • feat/my_cool_new_feature

  • fix/this_annoying_bug

  • …

Step 4.2 – Edit the sources

Use your fovourite editor or IDE to edit the sources.

Step 4.3 - Check the source code for correct format

pre-commit run --all-files

Step 4.4 - Test the changes

At a minimum, you should run the module tests:

pytest -vs --cov src --cov-report term-missing

You should also run the system tests. These include additional tests that interact with real resources:

pytest --system-test -vs --cov src --cov-report term-missing

To do profiling use:

python tests/single_test_optimization.py --profile

Step 4.5 - Commit the changes

Add the changed and new files to the commit.

Create a commit.

Step 5 - Pull request

Before creating a pull request assure the changes are based on the latest EOS upstream.

Update your local main branch:

git checkout main
git pull eos main

Switch back to your local development branch and rebase to main.

git checkout <MY_DEVELOPMENT_BRANCH>
git rebase -i main

During rebase you can also squash your changes into one (preferred) or a set of commits that have proper commit messages and can easily be reviewed.

After rebase run the tests once again.

If everything is ok push the commit(s) to your fork on Github.

git push -f origin

If your push by intention does not comply to the rules you can skip the verification by:

git push -f --no-verify origin

Once ready, submit a pull request with your fork to the Akkudoktor-EOS/EOS@master repository.

Developer Tips

Keep Your Fork Updated

Regularly pull changes from the eos repository to avoid merge conflicts:

git checkout main
git pull eos main
git push origin

Rebase your development branch to the latest eos main branch.

git checkout  <MY_DEVELOPMENT_BRANCH>
git rebase -i main

Create Feature Branches

Work in separate branches for each feature or bug fix:

git checkout -b feat/my-feature

Run Tests Frequently

Ensure your changes do not break existing functionality:

pytest -vs --cov src --cov-report term-missing

Follow Coding Standards

Keep your code consistent with existing style and conventions.

Use Issues for Discussion

Before making major changes, open an issue or discuss with maintainers.

Document Changes

Update docstrings, comments, and any relevant documentation.