Installation

The repository comes with a makefile script that can be run: make install executes pip install -e . and thereby installs the package to your local environment in editable mode. make install-dev additionally installs the dependencies required for development and initializes pre-commit hooks.

Mismo depends on our internal vicom package. If you run any of the two above make commands, vicom will not be automatically installed. You can either install the current version from the git repository by running pip install -e .[internal] or install a local version of the repo into your environment by running pip install -e . in that vicom folder.

!!! note

If you get a zsh: no matches found: .[internal] error, put the [internal] part in quotes: pip install -e '.[internal]''.

To include mismo into your project dependencies, add the following to your pyproject.toml dependencies: "mismo@git+ssh://git@github.com/viopsy/mismo.git"