-
Notifications
You must be signed in to change notification settings - Fork 5
Home
Welcome to the Mantis wiki!
Here you can find all the information you need to run and interact with Mantis.
The code is written in C++ and relies on libraries that are available for all major operating systems.
For windows there are executables avaialble under CPP/Bin folder. Make sure that the *exe and all *dlls are under the same folder and that the antivirus does not block the execution.
The building process for all operating systems is provided in the building section.
Mantis is a console application. To execute it, run the following command in your terminal (on Windows, you can use PowerShell):
MantisServer.exe -c config.ini
The following options are available when running the Mantis executable:
-
-v: Displays the current version and exits. -
-h: Shows the full list of available command-line options and exits. -
-c: config.ini : Runs the model using the parameters specified in the provided configuration file (config.ini). -
-n: Number of threads. You can define number of threads in the configuration file. However. with this option one can overwrite the value in the file
To help you begin working with Mantis, we have prepared several examples demonstrating:
- Input file preparation
- Scenario execution
-
Matlab guide for Tule River Example
⚠️ As we have stoped using Matlab for over a year now the above code does not align with the python code below. However, it gives you an overview of the workflow⚠️ - Python notebook for Tule River Example
-
Matlab guide for Tule River Example
These examples illustrate common workflows and provide practical guidance for configuring and running simulations.
The Mantis server application processes two distinct types of data:
- Initialization data (loaded at startup)
- Runtime data (received during execution)
Mantis requires predefined datasets to initialize the system before execution. These configure model parameters, domain settings, and other essential parameters.
Documentation:
📄 Initialization Data Specifications
Mantis remains idle until receiving an input command.
The input message has the KEYWORD VALUE format using spaces as separation character.
The input message has to be one line. The end line character \n indicates the end of the message.
Documentation:
📄 Runtime Data Options
Each input message triggers a structured response with the following format:
STATUS Nwell Nyr v1 v2 ... vlast ENDMSG\n
| Field | Description |
|---|---|
| STATUS |
1 (success) or 0 (failure). If 0, an error message follows. |
| Nwell | Number of wells in selected region(s) (integer) |
| Nyr | Number of simulated years (integer) |
| v1...vlast | Breakthrough curve (BTC) values (float). Sequence: First Nyr values = Well 1, next Nyr = Well 2, etc. |
| ENDMSG\n | Message terminator with newline. |
Although the preferred way to run Mantis is via our web interface, we provide the option to run and interact with it locally on a desktop PC.