Before starting#

Installation#

Using conda:

conda install conda-forge::ponio

Using sources:

git clone https://github.com/hpc-maths/ponio.git
cd ponio

and install dependencies from conda

conda env create -f environment/conda-environment.yml

Next, install ponio:

cmake . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --target install

Note

You can install and launch all examples and theirs dependencies with following command

conda env create -f environment/conda-environment-all.yml

Then, compile all examples with

cmake . -B build -DCMAKE_BUILD_TYPE=Release -DBUILD_ALL_EXAMPLES=ON
cd build
make visu # to launch all examples and script to plot output

Tip

For each example in ponio, there is a C++ source code and a Python script to compile, launch and visualize results. You can compile an example with

make lotka_volterra

You can also run the associated Python script to see results with

make visu_lotka_volterra
# or
make lotka_volterra_visu

You can also install dependencies with pixi with

pixi install

Variable	Default value	Description
`BUILD_TESTS`	`OFF`	Set to `ON` to build the tests with doctest
`BUILD_EXAMPLES`	`OFF`	Set to `ON` to build examples (without other dependencies)
`BUILD_EIGEN_EXAMPLES`	`OFF`	Set to `ON` to build examples with Eigen
`BUILD_CLI11_EXAMPLES`	`OFF`	Set to `ON` to build examples with CLI11
`BUILD_SAMURAI_EXAMPLES`	`OFF`	Set to `ON` to build examples with samurai
`BUILD_ALL_EXAMPLES`	`OFF`	Set to `ON` to build all examples with extra dependencies