Skip to main content

GitHub version Badge Badge Badge pre-commit badge


Offshore Oil and Gas Energy System Operational Optimisation Model (oogeso)

Python module for modelling and analysing the energy system of offshore oil and gas fields, with renewable energy and storage integration.

Part of the Low Emission Centre (SP5).

Getting started

Install latest Oogeso release from PyPi:

pip install oogeso

in order to use the plotting functionality you will need to install plotting libraries:

pip install matplotlib plotly seaborn

User guide and examples

The online user guide gives more information about how to specify input data and run a simulation case.

Local installation

Prerequisite:

  • Poetry
  • Pre-commit
  • CBC solver Clone or download the code and install it as a python package. I.e. navigate to the folder with the MANIFEST.in file and type:

Install dependencies

  1. git clone git@github.com:oogeso/oogeso.git
  2. cd oogeso
  3. poetry install --no-root --no-root to not install the package itself, only the dependencies.
  4. poetry shell
  5. poetry run pytest tests

Local development in Docker

Alternatively you can run and develop the code using docker and the Dockerfile in the root folder.

GitHub Actions Pipelines

4 pipelines are defined.

  1. Build: Building and testing on multiple OS and python versions. Triggered on any push to GitHub.
  2. CBC-optimizer CI: Build and test oogeso with the CBC-solver and spesific cbc-tests.
  3. Release: Create release based on tags starting on v*.
  4. Publish: Publish the package to PyPi when a release is marked as published.

Contribute

You are welcome to contribute to the improvement of the code.

  • Use Issues to describe and track needed improvements and bug fixes
  • Use branches for development and pull requests to merge into main
  • Use Pre-commit hooks

Contact

Harald G Svendsen
SINTEF Energy Research

Release files for oogeso 1.6.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 oogeso 1.6.0
File Size Uploaded
oogeso-1.6.0.tar.gz 60.1 kB Details

Built distribution (wheel)

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

Total release size: 139.8 kB

Release files / oogeso-1.6.0.tar.gz

Download URL oogeso-1.6.0.tar.gz
Size 60.1 kB
Tags Source
SHA-256 checksum
How to use checksums
6b81e9c791579d1e214b929557d3c0cd88513ad099fd822a10ad4acb3fe23386
BLAKE2b-256 checksum
How to use checksums
2ceb6caa7f2f724f84c4cf5e1380bdb9ce5f1b693752ead7bea05ca4e536b969
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.2 CPython/3.13.3 Linux/6.11.0-1012-azure

Release files / oogeso-1.6.0-py3-none-any.whl

Download URL oogeso-1.6.0-py3-none-any.whl
Size 79.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c83dc0e8062773e7ed9d89f9438270b050b1ba99f98d14b11e4fad8a55e756b5
BLAKE2b-256 checksum
How to use checksums
7326f034c39befaa5ec95043f9e1150ab9abd9e3f1728f9d1e61d44b80d49306
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.2 CPython/3.13.3 Linux/6.11.0-1012-azure

Release history Release notifications | RSS feed

This release

1.6.0 This release

2 release files

1.5.0

2 release files

1.1.1

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

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