Skip to content

Latest commit

 

History

History
45 lines (25 loc) · 2 KB

README.md

File metadata and controls

45 lines (25 loc) · 2 KB
Raw

SWITCH for REAM

Welcome! This repository contains the SWITCH electricity planning model adapted for the REAM research lab.

Available documentation

In docs/:

  • Overview.md: An overview of what SWITCH is and how it works, read

  • Usage.md: How to install, run or debug the different components of Switch

  • Developing Modules.md: How to create SWITCH modules from scratch

  • Contribute.md: How to contribute code to the project.

  • Graphs: How to create new graphs to analyze your results.

  • Database.md: All about the REAM database (e.g. how to connect to it and modify it)

  • Numerical Solvers.md: Information about numerical solvers, specifically Gurobi.

  • Numerical Issues.md: Information about detecting and resolving numerical issues.

  • Pandas.md: Crash course on the Pandas data manipulation library.

Finally, you can generate documentation for the SWITCH modules by running pydoc -w switch_model after having installed SWITCH. This will build HTML documentation files from python doc strings which will include descriptions of each module, their intentions, model components they define, and what input files they expect.

Key folders

  • /database Folder containing SQL scripts and files that keep track of updates to our PostgreSQL database.

  • /examples Folder with numerous examples of SWITCH projects often used for testing.

  • /switch_model Folder containing all the source code for the SWITCH modules.

  • /switch_model/wecc Folder containing modules specific to the REAM team.

  • /switch_model/wecc/get_inputs Scripts that fetch the input data from the PostgreSQL database.

  • /tests Folder containing tests for SWITCH. Can be run via python run_tests.py.