Skip to main content

Marlim3 logo


Marlim3 is a 1D multiphase flow simulator developed by Petrobras.

Core capabilities (steady-state and transient)

  • Production wells
  • Injection wells: Water or gas injection wells, both single-phase and multiphase
  • Networks
    • Production networks
    • Injection networks
    • Gas lift loops
  • Artificial Lift models: gas lift valves, pumps

Advanced modeling

  • Natural convection: 2D solutions for natural convection analysis in confined spaces (single-phase or two-phase), such as pipeline cross-sections during production shutdowns
  • Compositional fluid model library
  • Near wellbore model: radial and 2D models to consider phenomena such as water coning
  • Thermal diffusion: 2D and 3D coupled to the 1D flow model

Project status

Marlim3 is undergoing a major architectural refactoring. While that work is in progress:

  • Not every mapped bug in the current version will be fixed. Some defects live in code that the refactoring will replace, and fixing them twice is not a good use of anyone's time.
  • The current focus is verification. We are consolidating reference cases for the regression suite and validation cases for limiting conditions, so that the refactored engine can be checked against known-correct behaviour rather than against itself.
  • Issues where external collaboration is welcome are labelled help wanted. Those are scoped so they do not collide with the refactoring.

Bug reports remain valuable even when a fix is deferred — they inform what the new architecture has to get right, and they are candidates for the reference suite. Please keep them coming.

Broader contributions will be accepted once the refactoring settles. See CONTRIBUTING.md for what is being accepted in the meantime.

Documentation

Getting Started Installation, usage, and compilation
Python package Python API, bilingual interface, scripting
Model reference Every input section, key and unit
Theory Governing equations and discretization
Developer guide Engine internals
Tutorials Step-by-step notebooks
Desktop application Platform notes and diagnostics
Regression tool Model registration and native coverage
Tests Test suite and regression references

The full documentation is published at petrobras.github.io/marlim3.

Contributing

Contributions are welcome — see CONTRIBUTING.md, along with the Code of Conduct and the Contributor License Agreement. Note the project status above for what is being accepted during the refactoring.

Please use the Discussions section for questions rather than opening issues.

Note

Several resources and portions of the source code are currently written in Portuguese. We plan to gradually translate all content into English.

The Python API is fully bilingual (EN/PT) — see Bilingual Support.

Metadata

Release files for marlim3 3.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for marlim3 3.10.0
File Size Uploaded Provenance Actions
marlim3-3.10.0.tar.gz 516.1 kB Without provenance Details for marlim3-3.10.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for marlim3 3.10.0
File Interpreter ABI Platform Actions
marlim3-3.10.0-py3-none-any.whl Python 3 none any Details for marlim3-3.10.0-py3-none-any.whl

Total release size: 663.3 kB

Release files / marlim3-3.10.0.tar.gz

Download URL marlim3-3.10.0.tar.gz
Size 516.1 kB
Tags Source
SHA-256 checksum
How to use checksums
4bd63f6d28c02c7d2759f431e320f382cfcc93f1f0038677df8414370471fc5c
BLAKE2b-256 checksum
How to use checksums
db6f0bff5568bcd4e2742fe3d4f62d21ace1965b28c1cf1d4abe5096569f3cc3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / marlim3-3.10.0-py3-none-any.whl

Download URL marlim3-3.10.0-py3-none-any.whl
Size 147.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
25e4ea4409b957854b4e68932eb86f8768f0acd7e596dc49d868e40d4acf334a
BLAKE2b-256 checksum
How to use checksums
d13645ece34c20f246f50f416213bb58a6fc71b1772618d98ccd2f5db65c9696
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Security for marlim3 3.10.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page