developer_setup.md

Developer Setup

Set up the Python virtual environment

First, create a Python virtual environment with Python version >= 3.8 and activate it.

Using Virtualenv:

# Create a virtual environment.
# Only run this the first time.
python3 -m pip install virtualenv
python3 -m virtualenv -p python3 venv

# Activate the virtual environment.
source venv/bin/activate

Using Anaconda:

# Create a virtual environment.
# Only run this the first time.
conda create -n crfm-helm python=3.8 pip

# Activate the virtual environment.
conda activate crfm-helm

Install dependencies

To install any dependencies:

./install-dev.sh

If you run into errors when installing dependencies, please create a new Python virtual environment using the previous instructions, and then try installing the dependencies again.

Optionally, install Git commit hooks:

pre-commit install

Run tests

First, follow the earlier instructions to activate the virtual environment.

To run all unit tests:

python -m pytest

Append -vv to output the full diff and results:

python -m pytest -vv

To run a specific file, simply specify the path:

python -m pytest <path/to/file> -vv

Run linter and type-checker

To run the linter and type-checker:

./pre-commit.sh

If you previously installed the Git commit hooks using pre-commit install, then the linter and type-checker will be run whenever you run git commit. To skip running the linter and type checker when making a commit, use the --no-verify flag with git commit.