This is a development version of the SIMA documentation. You will find the official version at sima.sintef.no

Installation

1. Requirements

  • Python 3.11 or later.

  • SIMA 5.4 or later, for the examples that run SIMA. Set the environment variable SRE_EXE to sre.exe in the SIMA installation folder.

2. Install from PyPI

pip install simapy[all]

The all extra brings in h5py, which reads HDF5 results, and pandas, which makes frames. Without it SIMAPy still builds models and reads JSON results.

3. Run the examples

  1. Download examples.zip and unzip it. It holds the scripts and the input files they read.

  2. In the examples/ folder, create a virtual environment and activate it:

    python -m venv .venv
# On Windows
.venv\Scripts\activate
# On Linux/macOS
source .venv/bin/activate

  3. Install SIMAPy with the extras the examples use:

    pip install "simapy[all]" matplotlib

    Use the SIMAPy version that matches SIMA, for example "simapy[all]==5.4.*" for SIMA 5.4. The metocean examples need more:

    pip install -r metocean/requirements-metocean.txt

Run each script from the examples/ folder. python test_examples.py runs every example that needs no network access.

You are viewing documentation for an older version of SIMA. Go to the latest documentation →