Marlim3

https://marlim3.readthedocs.io/en/latest/
Admin
Marlim3 is a one-dimensional multiphase flow simulator based on the drift-flux model, featuring...
Tokens:142,526
Snippets:1,059
Trust Score:9.6
Update:5 days ago
Show doc for...
Tokens:
Raw
### Verify Marlim3 installation

Source: https://marlim3.readthedocs.io/en/latest/getting-started

Runs a Python one-liner to print the installed Marlim3 version. Use this after the initial setup to confirm the package is importable.

```bash
uv run --locked python -c "import marlim3; print(marlim3.__version__)"
```

--------------------------------

### Build Documentation with uv sync and mkdocs serve

Source: https://marlim3.readthedocs.io/en/latest

Commands to install documentation dependencies and serve the documentation locally using uv and mkdocs.

```bash
uv sync --group docs
uv run mkdocs serve

```

--------------------------------

### Setup and imports for Marlim3 nodal analysis

Source: https://marlim3.readthedocs.io/en/latest/tutorials/2-nodal_analysis

Loads autoreload extensions and imports matplotlib, numpy, marlim3, and copy for the tutorial. This is the initial setup cell for the notebook.

```python
%load_ext autoreload
%autoreload 2

import matplotlib.pyplot as plt
import numpy as np
import marlim3
import copy

```

--------------------------------

### Load Marlim3 and dependencies

Source: https://marlim3.readthedocs.io/en/latest/tutorials/1-horizontal_vertical_comparison

Sets up the notebook environment by loading the autoreload extension and importing numpy, marlim3, and copy. This is the initial setup for the tutorial.

```python
%load_ext autoreload
%autoreload 2

import numpy as np
import marlim3
import copy

```

--------------------------------

### Install dependencies and Python package with uv

Source: https://marlim3.readthedocs.io/en/latest/getting-started

Creates a .venv with Python 3.12+, installs dev tools (pytest, flake8, jupyter, etc.), and installs marlim3 in editable mode. After this step, you can use 'import marlim3' in your scripts.

```bash
uv sync --locked --group dev
```

--------------------------------

### Build Desktop Application with uv

Source: https://marlim3.readthedocs.io/en/latest/getting-started

Build the standalone desktop application for the current operating system. The script detects the platform, builds the native engine, installs desktop dependencies, and writes a release-named artifact to dist/.

```bash
uv run python -m marlim3_desktop.build
```

--------------------------------

### Run Marlim3 Desktop Application on Linux

Source: https://marlim3.readthedocs.io/en/latest/getting-started

Make the Linux desktop executable runnable and start it. The executable is a self-contained ELF binary requiring glibc 2.34 or newer.

```bash
chmod +x Marlim3-desktop-linux-x64
./Marlim3-desktop-linux-x64
```

--------------------------------

### Launch Marlim3 Streamlit GUI

Source: https://marlim3.readthedocs.io/en/latest/getting-started

Synchronize the GUI dependencies and start the Streamlit-based graphical interface. The GUI auto-detects an executable from build/ or marlim3/ under the repository root; otherwise, provide the executable path manually in the app.

```bash
uv sync --group gui
uv run streamlit run gui/app.py
```

--------------------------------

### Coupled Production/Service Segments Configuration (EN keys)

Source: https://marlim3.readthedocs.io/en/latest/single-branch-model-reference/pipes

Example JSON configuration for a coupled production and service pipe setup. Uses English keys. The initial config enables gas line and geometry follows flow, with XY mode disabled. Production and service pipes are defined with discretization cells.

```json
{
  "initialConfig": {
    "gasLine": true,
    "xyMode": false,
    "geometryFollowsFlow": true
  },
  "productionPipe": [
    {
      "id": 0,
      "active": true,
      "crossSectionId": 0,
      "angle": -1.57079632679,
      "formationId": 0,
      "thermalCoupling": 1,
      "grouping": true,
      "discretization": [
        {"numCells": 40, "length": 10.0}
      ]
    }
  ],
  "servicePipe": [
    {
      "id": 0,
      "active": true,
      "crossSectionId": 1,
      "angle": -1.57079632679,
      "grouping": true,
      "discretization": [
        {"numCells": 40, "length": 10.0}
      ]
    }
  ]
}
```

--------------------------------

### Example initialConfig JSON for Marlim3

Source: https://marlim3.readthedocs.io/en/latest/single-branch-model-reference/general

Shows a complete initialConfig JSON object for the Marlim3 simulator. It includes system, transient, slip, drift, flow pattern, mass transfer, and advanced settings. The tip advises keeping advanced and optional features at defaults until baseline results are validated.

```json
{
  "system": "PROD",
  "initialConfig": {
    "transient": false,
    "initialCondition": 1,
    "steadyStateSlip": true,
    "transientSlip": true,
    "driftModel": true,
    "flowPatternMap": 0,
    "massTransfer": 0,
    "steadyStateOrder": 1,
    "checkValve": 0,
    "geometryFollowsFlow": true,
    "gasLine": false,
    "pressureTable": true,
    "correlationsByPattern": {
      "stratified": 1,
      "slugBubble": 1,
      "annularChurn": 1
    },
    "advanced": {
      "threads": 1,
      "massTransferLimit": 10.0,
      "simplePressureFrontier": true,
      "accelerateSteadyConvergence": true
    }
  }
}
```

--------------------------------

### XY Mode with Correction Factors Configuration (PT keys)

Source: https://marlim3.readthedocs.io/en/latest/single-branch-model-reference/pipes

Example JSON configuration for XY mode with correction factors, using Portuguese keys. The initial config disables gas line and enables XY mode with starting coordinates. Two production pipes are defined with coordinates, cell counts, and correction factors for friction and temperature.

```json
{
  "configuracaoInicial": {
    "linhaGas": false,
    "modoXY": true,
    "xProdInicio": 0.0,
    "yProdInicio": -2000.0
  },
  "dutosProducao": [
    {
      "id": 0,
      "ativo": true,
      "idCorte": 0,
      "idFormacao": 0,
      "xCoor": 500.0,
      "yCoor": -1800.0,
      "nCelulas_XY": 25,
      "dPdLFric": 0,
      "dTdL": 0
    },
    {
      "id": 1,
      "ativo": true,
      "idCorte": 0,
      "idFormacao": 0,
      "xCoor": 1000.0,
      "yCoor": -1500.0,
      "nCelulas_XY": 50,
      "dPdLFric": 1,
      "dTdL": 1
    }
  ]
}
```

--------------------------------

### Initialize Marlim3 branch and configure simulation

Source: https://marlim3.readthedocs.io/en/latest/tutorials/5_temperature_pulse

Sets up the main Marlim3 object with initial settings, time control, production fluid, separator, and liquid source to simulate a thermal pulse.

```python
case = marlim3.Branch()
case.initialConfig = {
    "transient": True,
    "initialCondition": 0,
    "initialFluidId": 0
}
case.time = {
    "finalTime": 3000.0,
    "times": [0.0],
    "maxDT": [0.4]
}
case.productionFluid = [{
    "id": 0,
    "api": 35.95,
    "gor": 0.0,
    "gasDensity": 0.845,
    "bsw": 0.0
}]
case.separator = {
    "time": [0],
    "pressure": [15.0]
}
case.liquidSource = [{
    "id": 0,
    "prodFluidId": 0,
    "measuredLength": 0.0,
    "time": [0, 999, 1000, 1499, 1500, 3000],
    "temperature": [20.0, 20.0, 80.0, 80.0, 20.0, 20.0],
    "liquidFlowRate": [3000, 3000, 3000, 3000, 3000, 3000]
}]
```

--------------------------------

### Install Marlim3 via pip

Source: https://marlim3.readthedocs.io/en/latest/getting-started

Installs the Marlim3 Python package. On supported platforms, the first import downloads the matching native executable from GitHub Releases if not already present.

```bash
pip install marlim3
```

--------------------------------

### Simulate base case with gas lift (base_case_vgl.simulate())

Source: https://marlim3.readthedocs.io/en/latest/tutorials/3-gas_lift

Runs the simulation for the base case with gas lift using the %%time magic to measure execution time. The output includes a log file named 'simulacao.log' and CPU/wall time.

```python
%%time

base_case_vgl.simulate()

```

```text
*******************************************************************************
                                  UFA!!!!!!!!                                  
                        Quem vive de navegar, o vento e quem lhe comanda                
                          Seu Pereira na feira de artesanatos numericos                 
*******************************************************************************
ARQUIVO DE LOG: simulacao.log

CPU times: total: 31.2 ms
Wall time: 2.51 s

```

--------------------------------

### Install and test with uv sync and pytest

Source: https://marlim3.readthedocs.io/en/latest/dev-guide/dependencies

Use these commands to install dependencies and run tests in a public development environment. The --locked flag prevents automatic lock updates during normal development.

```bash
uv sync --locked --group dev
uv run --locked python -m pytest

```

--------------------------------

### Simulate strong coupling case (strong_coupling_case.simulate())

Source: https://marlim3.readthedocs.io/en/latest/tutorials/3-gas_lift

Runs the simulation for the strong coupling case using the %%time magic. The output includes a log file named 'simulacao.log' and CPU/wall time.

```python
%%time
strong_coupling_case.simulate()

```

```text
*******************************************************************************
                                  UFA!!!!!!!!                                  
                   Infeliz e o espirito ansioso pelo futuro.                    
                              Seneca do Mindfulness                                     
*******************************************************************************
ARQUIVO DE LOG: simulacao.log

CPU times: total: 31.2 ms
Wall time: 2.75 s

```

--------------------------------

### Install Homebrew GCC and CMake, then build on macOS

Source: https://marlim3.readthedocs.io/en/latest/getting-started

Install GCC and CMake via Homebrew, then configure and build Marlim3 using the gcc-release preset. The -j$(sysctl -n hw.ncpu) flag uses the number of hardware CPU cores for parallel compilation.

```bash
brew install gcc cmake
cmake --preset gcc-release
cmake --build --preset gcc-release -j$(sysctl -n hw.ncpu)

```
Tokens:
Raw