/PostREISE

Analyze and plot post simulation data

Primary LanguageJupyter NotebookMIT LicenseMIT

logo PyPI codecov made-with-python Code style: black Tests Documentation GitHub contributors GitHub commit activity GitHub last commit (branch) GitHub pull requests License: MIT Code of Conduct Slack

PostREISE

PostREISE is part of a Python software ecosystem developed by Breakthrough Energy Sciences to carry out power flow study in the U.S. electrical grid.

Main Features

Here are a few things that PostREISE can do:

  • Perform transmission congestion/utilization analyses of scenarios
  • Study generation/emission in scenarios
  • Plot results of analyses
  • Web dashboard with previously generated scenario results

A detailed tutorial can be found on our docs.

Where to get it

  • Clone or Fork the source code on GitHub
  • Get latest release from PyPi: pip install postreise

Dependencies

PostREISE relies on:

  • PowerSimData, another package developed by Breakthrough Energy Sciences and available here. You must have PowerSimData cloned in a folder adjacent to your clone of PostREISE as the installation of packages depends on files in PowerSimData.
  • Several Python packages all available on PyPi whose list can be found in the requirements.txt or Pipfile files both located at the root of this package.

Installation

  • Scenario data managed by PowerSimData are used by the analysis and plotting modules of PostREISE. Follow the instructions in the README of the PowerSimData package to install our software ecosystem.
  • Web dashboard: Check out the web_dashboard branch and see README in ./web_dashboard

License

MIT

Documentation

Code documentation in form of Python docstrings along with an overview of the package are available on our website.

Communication Channels

Sign up to our email list and our Slack workspace to get in touch with us.

Contributing

All contributions (bug report, documentation, feature development, etc.) are welcome. An overview on how to contribute to this project can be found in our Contribution Guide.