2. Setting up a development environment

Tip

We recommend creating a dedicated virtual environment for your pelicun development environment. See also conda and mamba, two widely used programs featuring environment management.

Clone the repository:

git clone --recurse-submodules https://github.com/NHERI-SimCenter/pelicun

Pelicun uses the SimCenter DamageAndLossModelLibrary as a submodule. In the above, recurse-submodules ensures that all files of that repository are also obtained.

Tip

If you are planning to contribute code, please fork the repository and clone your own fork.

Install pelicun in editable mode with the following command issued from the package’s root directory:

python -m pip install -e .[development]

This will install pelicun in editable mode as well as all dependencies needed for development.