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.1.1.tar.gz (56.8 kB view details)

Uploaded Source

Built Distribution

oogeso-1.1.1-py3-none-any.whl (74.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oogeso-1.1.1.tar.gz
  • Upload date:
  • Size: 56.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.9.18 Linux/6.2.0-1018-azure

File hashes

Hashes for oogeso-1.1.1.tar.gz
Algorithm Hash digest
SHA256 c925a79d5704b9b14ad82a72b339737ddd18cbf5978872b1754e29d657bae3ff
MD5 3c35d245c0abe404fe9b9f84b0db6914
BLAKE2b-256 04982c2ec3062960055d9db7d252184511179e1fdf5a87c3f7d7fc3432aca620

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oogeso-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 74.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.9.18 Linux/6.2.0-1018-azure

File hashes

Hashes for oogeso-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 472b3efca042be527fcbb0b3451fffeb0b179368a0993d3d99310e93b6042bb8
MD5 cd1c17d0e56b02f266c96eb825acb7b8
BLAKE2b-256 fb1b1717bb53fc113bf3330dbc67b09785680710bd2e719e4a543638e54152dc

See more details on using hashes here.

Supported by

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