Installing a Development Environment#

To contribute to mochada_kit, please fork the repository.

Set up a virtual environment, called e.g. “dev_mochada_kit” using venv in Python [1]:

python -m venv dev_mochada_kit

Change directories into your virtual environment and clone your forked repository into it (replacing “your-username” in the code below):

cd dev_mochada_kit
git clone https://github.com/your-username/mochada_kit.git

Activate the virtual environment:

Windows

.\Scripts\Activate.ps1

macOS

source bin/activate

Linux

source bin/activate

Set the upstream remote to the main mochada_kit repository:

cd mochada_kit
git remote add upstream https://github.com/MaMMoS-project/mochada_kit.git

Install mochada_kit in editable mode with the optional dependencies for development:

pip install -e .[dev]

Footnotes