marlim3 3.3.0__tar.gz

marlim3-3.3.0/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Petróleo Brasileiro S.A.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

marlim3-3.3.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include _version.py
+include tutoriais/*.json
+include marlim3/Marlim3
+include marlim3/Marlim3.exe

marlim3-3.3.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: marlim3
+Version: 3.3.0
+Summary: Simulação de escoamento multifásico permanente e transiente.
+Home-page: https://github.com/petrobras/marlim3
+Author: Equipe Marlim 3
+Author-email: cc-simuladormarlim3@petrobras.com.br
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: numpy
+Requires-Dist: scikit-learn
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: openpyxl
+Requires-Dist: typing
+Requires-Dist: plotly
+Requires-Dist: seaborn
+Requires-Dist: networkx
+Requires-Dist: nbformat
+Requires-Dist: ipython
+Requires-Dist: jinja2
+Requires-Dist: requests
+Requires-Dist: pytest
+Requires-Dist: pytest-cov
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+<h1 align="center">
+<img src="img/logo_marlim3.svg" alt="drawing" width="300"/>
+
+</h1><br>
+
+Marlim3 is a multiphase flow simulator developed by Petrobras.
+
+The types of simulations offered by Marlim3 include:
+
+- **Multiphase flow systems**: Steady-state or transient production wells
+- **Single-phase flow systems** (steady-state): Water or gas injection wells, typically under supercritical conditions
+- **Networks**:
+    - Standard production networks (steady-state and transient)
+    - Standard injection networks (steady-state)
+    - Gas lift rings (steady-state and transient)
+- **Natural convection**: 2D solutions for natural convection analysis in confined spaces (single-phase or two-phase). Example: modeling natural convection in a pipeline cross-section during a production shutdown
+
+## Installation
+
+### Option 1: Install via pip
+
+Install Marlim3 as a Python package:
+
+```bash
+python3 -m venv ~/marlim3-env
+source ~/marlim3-env/bin/activate
+pip install -e . -v
+```
+
+If you prefer a regular installation instead of editable mode:
+
+```bash
+pip install .
+```
+
+#### Requirements
+
+- Python >= 3.12
+
+
+### Option 2: Use the executable directly
+
+If you already have the Marlim3 executable available, you can run simulations directly from the terminal without installing the Python package, as detailed below.
+
+## Usage
+
+Marlim3 can be used in **two different ways**:
+
+### Option 1: Python Package
+
+Use Marlim3 as a Python library in your scripts:
+
+```python
+import marlim3
+
+# Your simulation code here
+# Example: configure and run simulations programmatically
+```
+
+**This option is ideal for:**
+- Integration with other Python tools and workflows
+- Automated batch simulations
+- Pre/post-processing with Python libraries (pandas, numpy, matplotlib, etc.)
+- Building custom applications
+
+### Option 2: Command-Line Executable
+
+Run Marlim3 directly from the terminal using the compiled executable.
+
+#### Available Commands
+
+There are four simulation types available:
+
+**1. Simple Production System**
+```bash
+./executable_name -d directory_name -i input_file
+```
+
+**2. Simple Injection System**
+```bash
+./executable_name -d directory_name -i input_file -s INJETOR
+```
+
+**3. Flow Network**
+```bash
+./executable_name -d directory_name -i input_file -s REDE
+```
+
+**4. Natural Convection in Cross-Section**
+```bash
+./executable_name -d directory_name -i input_file -s CONVECNAT
+```
+
+#### Command-Line Arguments
+
+- `-d directory_name`: Output directory for simulation results
+- `-i input_file`: Input file name (JSON format)
+- `-s SIMULATION_TYPE`: Simulation type (INJETOR, REDE, or CONVECNAT)
+
+#### Platform-Specific Notes
+
+**Linux/macOS:**
+```bash
+./Marlim3 -d ./output -i simulation.json -s REDE
+```
+
+**Windows:**
+```powershell
+Marlim3.exe -d .\output -i simulation.json -s REDE
+```
+
+> **Tip:** To export results to the current working directory, use `./` (Linux/macOS) or `.\` (Windows) as the directory name.
+
+## Compilation
+
+Compilation is only necessary if you need to build or rebuild the executable from source.
+
+### Requirements
+
+- GCC/G++ >= 9.0
+- GFortran >= 9.0
+
+### Build the executable
+
+```bash
+cd src
+make clean all
+```
+
+If you wish to use the new executable with the Python package, copy the generated file to the `marlim3` directory and install it locally using pip.
+
+## Note
+
+Several resources and portions of the source code are currently written in Portuguese. We plan to gradually translate all content into English.

marlim3-3.3.0/README.md

@@ -0,0 +1,134 @@
+<h1 align="center">
+<img src="img/logo_marlim3.svg" alt="drawing" width="300"/>
+
+</h1><br>
+
+Marlim3 is a multiphase flow simulator developed by Petrobras.
+
+The types of simulations offered by Marlim3 include:
+
+- **Multiphase flow systems**: Steady-state or transient production wells
+- **Single-phase flow systems** (steady-state): Water or gas injection wells, typically under supercritical conditions
+- **Networks**:
+    - Standard production networks (steady-state and transient)
+    - Standard injection networks (steady-state)
+    - Gas lift rings (steady-state and transient)
+- **Natural convection**: 2D solutions for natural convection analysis in confined spaces (single-phase or two-phase). Example: modeling natural convection in a pipeline cross-section during a production shutdown
+
+## Installation
+
+### Option 1: Install via pip
+
+Install Marlim3 as a Python package:
+
+```bash
+python3 -m venv ~/marlim3-env
+source ~/marlim3-env/bin/activate
+pip install -e . -v
+```
+
+If you prefer a regular installation instead of editable mode:
+
+```bash
+pip install .
+```
+
+#### Requirements
+
+- Python >= 3.12
+
+
+### Option 2: Use the executable directly
+
+If you already have the Marlim3 executable available, you can run simulations directly from the terminal without installing the Python package, as detailed below.
+
+## Usage
+
+Marlim3 can be used in **two different ways**:
+
+### Option 1: Python Package
+
+Use Marlim3 as a Python library in your scripts:
+
+```python
+import marlim3
+
+# Your simulation code here
+# Example: configure and run simulations programmatically
+```
+
+**This option is ideal for:**
+- Integration with other Python tools and workflows
+- Automated batch simulations
+- Pre/post-processing with Python libraries (pandas, numpy, matplotlib, etc.)
+- Building custom applications
+
+### Option 2: Command-Line Executable
+
+Run Marlim3 directly from the terminal using the compiled executable.
+
+#### Available Commands
+
+There are four simulation types available:
+
+**1. Simple Production System**
+```bash
+./executable_name -d directory_name -i input_file
+```
+
+**2. Simple Injection System**
+```bash
+./executable_name -d directory_name -i input_file -s INJETOR
+```
+
+**3. Flow Network**
+```bash
+./executable_name -d directory_name -i input_file -s REDE
+```
+
+**4. Natural Convection in Cross-Section**
+```bash
+./executable_name -d directory_name -i input_file -s CONVECNAT
+```
+
+#### Command-Line Arguments
+
+- `-d directory_name`: Output directory for simulation results
+- `-i input_file`: Input file name (JSON format)
+- `-s SIMULATION_TYPE`: Simulation type (INJETOR, REDE, or CONVECNAT)
+
+#### Platform-Specific Notes
+
+**Linux/macOS:**
+```bash
+./Marlim3 -d ./output -i simulation.json -s REDE
+```
+
+**Windows:**
+```powershell
+Marlim3.exe -d .\output -i simulation.json -s REDE
+```
+
+> **Tip:** To export results to the current working directory, use `./` (Linux/macOS) or `.\` (Windows) as the directory name.
+
+## Compilation
+
+Compilation is only necessary if you need to build or rebuild the executable from source.
+
+### Requirements
+
+- GCC/G++ >= 9.0
+- GFortran >= 9.0
+
+### Build the executable
+
+```bash
+cd src
+make clean all
+```
+
+If you wish to use the new executable with the Python package, copy the generated file to the `marlim3` directory and install it locally using pip.
+
+## Note
+
+Several resources and portions of the source code are currently written in Portuguese. We plan to gradually translate all content into English.

marlim3-3.3.0/_version.py

@@ -0,0 +1,3 @@
+"""Version information for Marlim3 package."""
+
+__version__ = '3.3.0'

marlim3-3.3.0/marlim3/__init__.py

@@ -0,0 +1,30 @@
+"""
+Marlim3 - Simulacao de escoamento multifasico permanente e transiente.
+"""
+
+# Import version from root _version.py
+import sys
+from pathlib import Path
+
+# Try to import from root _version.py (for development)
+try:
+    _root_dir = Path(__file__).parent.parent
+    if (_root_dir / '_version.py').exists():
+        exec(open(_root_dir / '_version.py').read())
+    else:
+        # Fallback for installed package
+        __version__ = '3.3.0'
+except:
+    # Fallback
+    __version__ = '3.3.0'
+
+# Ensure executable is downloaded on first import
+from ._download import ensure_executable
+ensure_executable()
+
+# Import main classes
+from ._tramo._tramo import Tramo
+from ._rede._rede import Rede
+from ._cenarios._cenarios import Cenarios
+
+__all__ = ['Tramo','Rede','Cenarios', '__version__']

marlim3-3.3.0/marlim3/_cenarios/_cenarios.py

@@ -0,0 +1,40 @@
+from .._plots._plots_perfis import _plotar_perfis
+from .._plots._plots_tends import _plotar_tendencias_cenarios
+
+class Cenarios:
+
+    def __init__ (self, casos = None):
+
+        self.casos = casos if casos is not None else {}
+
+        # adicionar analise de sensibilidade nativa do marlim
+
+    def plotar_perfis(self, linha = 'producao'):
+
+        dfs = []
+
+        if linha == 'producao':
+            PERFIS = 'perfilProducao'
+        elif linha == 'servico':
+            PERFIS = 'perfilServico'
+        else:
+            print('argumento linha só pode ser producao ou servico')  
+
+        for rotulo, caso in self.casos.items():
+            dfs.append(caso.resultados[PERFIS])
+
+        fig, axes = _plotar_perfis(dfs, 
+                                   rotulos=list(self.casos.keys()),
+                                   linha=linha)
+
+        return fig, axes
+
+    def plotar_tendencias(self):
+
+        tends_list = []
+        
+        for rotulo, caso in self.casos.items():
+            tends_list.append(caso.resultados['tendP'])
+
+        _plotar_tendencias_cenarios(tends_list,
+                                    rotulos=list(self.casos.keys()))