Readme#

Setting up for local development#

Assumes a “modern” version of Ubuntu (I use Ubuntu 20.04.2 LTS) with basic dependencies installed.

To get started, run the following commands:

1. Installing Poetry and Invoke

   curl -sSL https://install.python-poetry.org/ | python -
   pip install invoke
   

2. Installing the project

   git clone git@github.com:rsundqvist/rics.git
   cd rics
   poetry install -E translation -E plotting
   

3. Install commit hooks (optional)

   inv install-hooks
   

4. Verify installation (optional)

   ./run-invocations.sh
   

Credits#

This package was created with Cookiecutter and the fedejaure/cookiecutter-modern-pypackage project template.