A Guide to Reproducible Python Environments and CADET Installations

Installing a Custom Version of a Package From a Git Branch or Commit

You can also use pip within a Conda/ Mamba environment to install packages directly from a specific Git branch or commit. This requires Git to be installed.

Warning: mixing conda and pip can lead to problems and might break your conda environment. Pip commands should therefore only be used within conda environments and not in the base environment.

pip install git+https://github.com/your-user/your-repo.git@your-branch

e.g., to install the dev version of CADET-Process, run the following:

pip install git+https://github.com/fau-advanced-separations/CADET-Process.git@dev

or with SSH:

pip install git+ssh://git@github.com/fau-advanced-separations/CADET-Process.git@dev

or from gitlab e.f. the CADET RDM tool

pip install git+ssh://git@jugit.fz-juelich.de/IBG-1/ModSim/cadet/CADET-RDM.git@master

This syntax can also be used in environment.yml files:

[...]
#  - git         # optional, for version control
  - pip:
      - git+ssh://git@github.com/fau-advanced-separations/CADET-Process.git@dev
[...]