README.md

cerf

cerf is an open-source geospatial Python package for evaluating and analyzing future electricity technology capacity expansion feasibility.

Purpose

cerf was created to:

• Evaluate the feasibility of a future scenario-driven electricity technology capacity expansion plan as generated by a parent model,

• Site power plants in the least cost configuration when considering regional economics an on-the-ground barriers to siting,

• Assist planners and modelers of alternate future realizations of the electricity system to gain an understanding of how siting costs and service area congestion may respond under certain stressors.

Install cerf

pip install cerf

Check out a quickstart tutorial to run cerf

Run cerf using the quicktart tutorial: cerf Quickstarter

Getting started

New to cerf? Get familiar with what cerf is all about in our Getting Started docs!

User guide

Our user guide provides in-depth information on the key concepts of cerf with useful background information and explanation. See our User Guide

Contributing to cerf

Whether you find a typo in the documentation, find a bug, or want to develop functionality that you think will make cerf more robust, you are welcome to contribute! See our Contribution Guidelines

API reference

The reference guide contains a detailed description of the cerf API. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts. See API Reference