Skip to main content

Offshore Oil and Gas Field Energy System Operational Optimisation (OOGESO)

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oogeso-1.6.0.tar.gz (60.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oogeso-1.6.0-py3-none-any.whl (79.6 kB view details)

Uploaded Python 3

File details

Details for the file oogeso-1.6.0.tar.gz.

File metadata

  • Download URL: oogeso-1.6.0.tar.gz
  • Upload date:
  • Size: 60.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.13.3 Linux/6.11.0-1012-azure

File hashes

Hashes for oogeso-1.6.0.tar.gz
Algorithm Hash digest
SHA256 6b81e9c791579d1e214b929557d3c0cd88513ad099fd822a10ad4acb3fe23386
MD5 601c71082ca6f732016f3a7106a4dca1
BLAKE2b-256 2ceb6caa7f2f724f84c4cf5e1380bdb9ce5f1b693752ead7bea05ca4e536b969

See more details on using hashes here.

File details

Details for the file oogeso-1.6.0-py3-none-any.whl.

File metadata

  • Download URL: oogeso-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 79.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.13.3 Linux/6.11.0-1012-azure

File hashes

Hashes for oogeso-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c83dc0e8062773e7ed9d89f9438270b050b1ba99f98d14b11e4fad8a55e756b5
MD5 20589f8f6aac2d06d3e5818142c4710f
BLAKE2b-256 7326f034c39befaa5ec95043f9e1150ab9abd9e3f1728f9d1e61d44b80d49306

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page