Getting started¶

Installation¶

Typically, you want to create a new Python 3.10 environment, e.g., with conda or mamba:

mamba create -n vasca python=3.10
mamba activate vasca

The installation steps are:

Clone this repository:

git clone git@github.com:rbuehler/vasca.git

Install the VASCA package:

cd ./vasca
pip install -e .

Set up the resource manager by including your cloud path location in the .env_template file and rename it to .env.

Running the pipeline and post-processing¶

We use Jupyter Lab for post-processing, with functional examples provided in vasca/examples.

Coding guidelines¶

We use the PEP 8 coding conventions. Before contributing, please consider the use of automatic code formatting tools like isort, flake8, and black. We set 88 characters as the default line width. The recommended Python version to use is 3.10.x. For docstrings, we use the numpy format.

Build the documentation¶

For documentation, we use SPHINX. To build it, run the following:

sphinx-apidoc -f -o docs vasca
cd docs/
make html

To create Unified Modeling Language diagrams, install pyreverse and graphviz, then run:

pyreverse vasca -o png -d ./docs/