Zoomy

Flexible modeling and simulation software for free-surface flows.

Documentation

See our Documentation for details on

• how to get started
• installation instructions
• tutorials
• examples
• ...

Installation

Conda/Mamba

CPU (Linux / Mac)

Installation

cd install
conda env create -f env-zoomy.yml
./conda_config_setup.sh

Activation

conda activate zoomy

GPU (Linux / Mac)

cd install
conda env create -f env-zoomy-gpu.yml
./conda_config_setup.sh

Activation

conda activate zoomy-gpu

Docker

T.b.d

Apptainer

T.b.d

Manual installation

See the install/environment.ymlor the install/environment-gpu.yml for a complete list of requirements. Once the requirements are fulfilled, simply clone the repository.

The following environment variables need to be set

PYTHONPATH=/path/to/Zoomy
ZOOMY_DIR=/path/to/Zoomy
JAX_ENABLE_X64=True
PETSC_DIR=/path/to/petsc/installation
PETSC_ARCH=architecture used for compiling petsc

License

The Zoomy code is free open-source software, licensed under version 3 or later of the GNU General Public License. See the file LICENSE for full copying permissions.

Publications

T.b.d.

BibTex Citation

T.b.d.