Skip to main content

An open-source geospatial Python package for assessing and analyzing future electricity technology capacity expansion feasibility.

Project description

build DOI status

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

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cerf-2.4.0.tar.gz (32.0 kB view details)

Uploaded Source

Built Distribution

cerf-2.4.0-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

Details for the file cerf-2.4.0.tar.gz.

File metadata

  • Download URL: cerf-2.4.0.tar.gz
  • Upload date:
  • Size: 32.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.7

File hashes

Hashes for cerf-2.4.0.tar.gz
Algorithm Hash digest
SHA256 f39127a63b6317f961d14ed3c2c2570a5cb3274b130b12fde7529006c5c79b18
MD5 2d985d01c8b16bd09a640ec96814edbd
BLAKE2b-256 f751b765648227ff64d96e996eec4bc4798a73fd48c7bdc47fcac676730c90b4

See more details on using hashes here.

File details

Details for the file cerf-2.4.0-py3-none-any.whl.

File metadata

  • Download URL: cerf-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 39.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.7

File hashes

Hashes for cerf-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f1efced9ab519c685d92494323e032d7041c7304af6c8b0cb18eaf7968862c99
MD5 e8aa67d8727177d66c39f0064b6a574d
BLAKE2b-256 5d36e3174eea1fbbc4388413269bc382b9531854054177f0deb261a50158e9e1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page