Installation

Cloning STEVMA

First, clone the repository in your computer:

git clone https://github.com/asimazbunzel/stevma.git

or

git clone git@github.com:asimazbunzel/stevma.git

depending if you have git set up or you are using an SSH key.

Installing STEVMA

Once the repository is cloned in a local directory, cd into this new directory and run the following code

pip install -U stevma

or install it using Poetry

poetry add stevma

This will create the executable run-manager that will handle the creation of the grid.

Then, you can run

run-manager --help

or with Poetry

poetry run run-manager --help

Note

USE A CONDA ENVIRONMENT

The usage of a conda environment is strongly recommended as it will automatically handle the different versions of the libraries needed by the code to work

STEVMA development

Here is how to set up STEVMA for development purposes. See also Contributing for how to prepare your GitHub fork of the module.

Makefile usage

Makefile contains a lot of functions for faster development.

  1. Download and remove Poetry

To download and install Poetry run:

make poetry-download

To uninstall

make poetry-remove

  1. Install all dependencies and pre-commit hooks

Install requirements:

make install

Pre-commit hooks coulb be installed after git init via

make pre-commit-install

  1. Codestyle

Automatic formatting uses pyupgrade, isort and black.

make codestyle

# or use synonym
make formatting

Codestyle checks only, without rewriting files:

make check-codestyle

Note

check-codestyle uses isort, black and darglint library

Update all dev libraries to the latest version using one comand

make update-dev-deps

  1. Code security

make check-safety

This command launches Poetry integrity checks as well as identifies security issues with Safety and Bandit.

make check-safety

  1. Type checks

Run mypy static type checker

make mypy

And many more ! See much more information on this template