Giter VIP home page Giter VIP logo

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 [email protected]: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

oogeso's Projects

oogeso icon oogeso

Python application for modeling and analyzing the energy system of offshore oil and gas fields, with renewable energy and storage integration.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.