Mooi-Kickstart/pyrecoy/pyrecoy

The pyrecoy Package

Modelling framework and tools and modelling of flexible assets on energy markets.

Getting started:

Prerequisites

• It is recommended to set-up your Python development environment according to this Wiki page
• The pyrecoy package is best used in a Jupyter Lab / Notebooks environment
• Environment variables:
  • ICE_USERNAME and ICE_PASSWORD login credentials to https://www.ice.if5.com are required if you want to use TTF (gas) and ETS (CO2) prices in your model.
  • FORECAST_DATA_FOLDER: Local path to the "Forecast Data" folder on the Sharepoint server. This is required if you want to use forecast/price data in your model, e.g. C:/Users/username/Recoy/Recoy - Documents/03 - Libraries/12 - Data Management/Forecast Data/
• Jupyter Lab extensions:
  • ipywidgets and the Plotly extension may be needed to view all graphs as intended.

Installation

For usage in specific project only

• Clone the repo to your project directory

For global installation in your Python environment

• Run pip install git+ssh://git@gitlab.com/recoy-internal/pyrecoy-package.git
• You should be able import pyrecoy package in any Python script using your environment

Usage:

...