pypontem 1.1.2

The one-stop python toolkit for Flow Assurance workflows

Welcome to pypontem

pypontem is a Python-based library designed for postprocessing simulation outputs generated by OLGA, a leading transient multiphase flow simulator. It helps flow assurance engineers efficiently extract, organize, and analyze simulation data.

Table of Contents

• Key Features
• Installation
• Usage Example
• Authors
• Further Resources
• Contributing
• License
• Contact & Support

Key Features

• Metadata Extraction – Retrieve simulation metadata (e.g., version, title, author).
• Branch Analysis – Identify branch names and extract elevation profiles.
• Variable Search – Search variable catalogs based on name, location, or pipeline section.
• Trend Data Extraction – Extract time-series data from TPL files.
• Profile Data Extraction – Extract spatial profile data from PPL files.
• Unit Conversion – Seamless and robust handling of unit transformations.

Installation

pypontem requires Python 3.12.3. Follow these steps to install:

# Create a new Conda environment
conda create -n pypontem_env python=3.12.3 jupyter 

# Activate the environment
conda activate pypontem_env

# Install the package
pip install pypontem

Usage Example

Once installed, you can start using pypontem as follows:

from pypontem.tpl.tplparser import tplParser

# Load a sample OLGA simulation file
tpl = tplParser(r'example_tpl.tpl')

# Extract metadata from a tpl file
metadata = tpl.metadata
print(metadata)

For a detailed walkthrough, check the official documentation.

Contributing

We welcome contributions! Follow these steps to contribute:

1. Fork the repository.
2. Create a new branch.
3. Make your changes and commit them.
4. Submit a pull request for review.

Authors

• Pontem Analytics

Further Resources

• 📚 Official Documentation – Learn how to use pypontem effectively.
• 💻 GitHub Repository – Explore the source code, contribute, or report issues.

License

This project is licensed under the MIT License.

Contact & Support

For support, feature requests, or bug reports, open an issue in the GitHub repository