Setting up the local environment#

Creating a local copy of the project#

  1. Clone the repository.

  2. Create an environment (conda/mamba/virtualenv/etc).

  3. Switch to the project folder and install the package and all dependencies:

cd meegsim
pip install -e .[dev]

  1. You’re ready to start now!

Running Tests#

pytest

Building the Documentation#

  1. Install the required packages.

pip install -e .[docs]

  1. Build the documentation.

make html

  1. Open it in the web browser.

make show