wuhochi / cerf Goto Github PK

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.

NOTE: cerf is not officially supported for Ubuntu 18 users due to a system dependency (GLIBC_2.29) required by the whitebox package which cerf uses to conduct spatial analysis. Ubuntu 18 natively includes GLIBC_2.27. It may be possible for Ubuntu 18 users to upgrade to GLIBC_2.29 but this should be done with careful consideration. Instead, we officially support cerf use for Ubuntu users for versions 20.04.2 LTS and greater.

pip install cerf

Run cerf using the quicktart tutorial: cerf Quickstarter

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

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

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

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