openTELEMAC conda package

This is the repository for the conda package of the openTELEMAC system

Current build status

Windows	Dependencies Version Last update opentelemac opentelemac-examples opentelemac-documentation
Ubuntu	Dependencies Version Last update opentelemac opentelemac-examples opentelemac-documentation

Introduction

The opentelemac solver suite is a high-performance Fortran based application for a range of free-surface flow problems.

This software is a very powerful toolkit for numeric simulation that can be slightly cumbersome to install depending on the host operating system. The runtime might also need some tweaks to the configuration provided in the upstream repository to reflect Fortran compiler version and library locations.

Currently, only win-64 package is provided.

How to install?

it is recommended to use Miniforge3.

On Windows

1. Download and install miniforge3

2. In Miniforge Prompt:

   mamba create -n opentelemac -c nicogodet opentelemac
   mamba activate opentelemac

3. Depending on your .py file association settings, it is recommended to run TELEMAC module using:

   python -m module argument

   Exemple:

   python -m telemac2d --ncsize=4 -s cas_file.cas

On Ubuntu

1. See wiki to Download and install mamba

2. In terminal:

   mamba create -n opentelemac -c tomsail opentelemac
   mamba activate opentelemac

3. All telemac scripts have been added to PATH & PYTHONPATH. So you can just use TELEMAC with:

   module.py argument

   Exemple:

   telemac2d.py --ncsize=4 -s cas_file.cas

Current implemented features

Build

• Static build (not currently packaged)
• Dynamic build with API

Lib

Windows

• Parallel computing using m2w64-msmpi (from nicogodet anaconda repo)
• MUMPS (scalapack) support using m2w64-scalapack (from nicogodet anaconda repo) and m2w64-mumps (from nicogodet anaconda repo)

Ubuntu

• Parallel computing using openmpi
• MUMPS for ARTEMIS parallel computing
• GOTM, AED2 and MED (MED not currently working) using med-otm, gotm-otm and aed2-otm.

Custom commands

• Command switch to use debug build telemac-debug [on/off]

Extra

• Provide opentelemac-examples package

  Windows:

  mamba install -c nicogodet opentelemac-examples

  Linux:

  mamba install -c tomsail opentelemac-examples

• Provide opentelemac-documentation package

  Windows:

  mamba install -c nicogodet opentelemac-documentation

  Linux:

  mamba install -c tomsail opentelemac-documentation

To check that the environment is correctly installed, first activate your conda environment :

mamba activate telemac

then try to compile the binaries from the sources:

compile_telemac.py

Run an example

For the sake of space, this package does not comport the examples, notebooks and documentation.

We suggest either :

1. download the latest tag v8p4 on the openTELEMAC repository:

   git clone https://gitlab.pam-retd.fr/otm/telemac-mascaret.git` git checkout -b v8p4r0 git pull origin v8p4r0

2. use the opentelemac-examples package cited above

then go to any example and run it:

cd examples/tomawac/Manche
tomawac.py tom_manches.cas

Production Plan :

First release (done):

• minimal version necessary for the latest openTELEMAC version v8p4

Second release (current):

• all the optionals libraries needed for:
  • solver optimisation (MUMPS)
  • GOTM (General Ocean Turbulence Model)
  • BLAS / LAPACK libraries
  • AED2

Third release:

• Salomé formats (MED)

For more information check out the wiki