Installation development

Clone the repository

To get started clone the mammos-spindynamics repository via ssh:

git clone git@github.com:MaMMoS-project/mammos-spindynamics.git

or https if you don't have an ssh key:

git clone https://github.com/MaMMoS-project/mammos-spindynamics.git

Then enter into the repository:

cd mammos-spindynamics

install pixi
activate pre-commits by running pre-commit install
run pixi shell to create and activate an environment in which mammos-spindynamics is installed (this will install python as well)
the following pixi tasks are provided:
- pixi run test-unittest: Run unittests with pytest (reading tests/)
- pixi run test-docstrings: Run doctests with pytest (reading src/mammos_spindynamics)
- pixi run test-notebooks: Run nbval with pytest on notebooks (reading examples/)
- pixi run test-all: run unittest, doctest and notebooktest
- pixi run examples: start jupyter lab in examples/ directory
- pixi run style: style checks on all files using pre-commit run --all-files