Installation

Stable release

To install WaveBreaking, run this command in your terminal:

pip install wavebreaking

This is the preferred method to install WaveBreaking, as it will always install the most recent stable release. Your virtual environment is automatically checked for the necessary dependencies. After the installation, you can start calculating RWB events by following the tutorial below.

From sources

The sources for WaveBreaking can be downloaded in two different ways. You can either install WaveBreaking directly from the GitHub repository:

pip install git+https://github.com/skaderli/WaveBreaking

Or you can clone the GitHub repository first and then install WaveBreaking locally. For that, start with setting the working directory and cloning the repository.

git clone https://github.com/skaderli/WaveBreaking.git
cd /path/to/local/WaveBreaking

Second, set up the conda environment and install the necessary dependencies (this may take some time):

conda create -y -n wb_env
conda env update -f environment.yml -n wb_env

Now activate the environment and install the WaveBreaking package locally by using the developer mode “-e”:

conda activate wb_env
pip install -e .

To check if the installation was successful, perform some tests:

python -m unittest tests.test_wavebreaking