Data

Tools

Indexes

Applications

Experiments

Open Source Science

cerf

cerf: A Python package to evaluate the feasibility and costs of power plant siting for alternative futures - Published in JOSS (2021)

https://github.com/immm-sfa/cerf

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ✓
    Institutional organization owner
    Organization immm-sfa has institutional domain (im3.pnnl.gov)
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Earth and Environmental Sciences Physical Sciences - 62% confidence
Last synced: 4 months ago · JSON representation ·

Repository

The Capacity Expansion Regional Feasibility (CERF) model

Basic Info
Statistics
  • Stars: 16
  • Watchers: 5
  • Forks: 9
  • Open Issues: 13
  • Releases: 24
Created about 8 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

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.

bash 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

Owner

  • Name: Integrated Multisector Multiscale Modeling
  • Login: IMMM-SFA
  • Kind: organization
  • Location: Richland, WA

Models and code from the IM3 SFA

JOSS Publication

cerf: A Python package to evaluate the feasibility and costs of power plant siting for alternative futures
Published
September 26, 2021
DOI
Volume 6, Issue 65, Page 3601
Authors
Chris R. Vernon ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Jennie S. Rice ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Nino Zuljevic ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Kendall Mongird ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Kristian Nelson ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Gokul Iyer ORCID
Joint Global Change Research Institute, PNNL, College Park, MD., USA
Nathalie Voisin ORCID
Pacific Northwest National Laboratory, Richland, WA., USA
Matthew Binsted ORCID
Joint Global Change Research Institute, PNNL, College Park, MD., USA
Editor
Frauke Wiese ORCID
Tags
power plant siting electricity capacity expansion
View PDF Review Thread Software Archive

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software in your work, please cite it as below."
authors:
- family-names: "Vernon"
  given-names: "Chris R."
  orcid: "https://orcid.org/0000-0002-3406-6214"
- family-names: "Rice"
  given-names: "Jennie S."
  orcid: "https://orcid.org/0000-0002-7833-9456"
- family-names: "Zuljevic"
  given-names: "Nino"
  orcid: "https://orcid.org/0000-0002-3175-9277"
- family-names: "Mongird"
  given-names: "Kendall"
  orcid: "https://orcid.org/0000-0003-2807-7088"
- family-names: "Nelson"
  given-names: "Kristian"
  orcid: "https://orcid.org/0000-0002-6745-167X"
- family-names: "Iyer"
  given-names: "Gokul"
  orcid: "https://orcid.org/0000-0002-3565-7526"
- family-names: "Voisin"
  given-names: "Nathalie"
  orcid: "https://orcid.org/0000-0002-6848-449X"
- family-names: "Binsted"
  given-names: "Matthew"
  orcid: "https://orcid.org/0000-0002-5177-7253"
title: "cerf: A Python package to evaluate the feasibility and costs of power plant siting for alternative futures"
version: 2.2.1
doi: 10.5281/zenodo.1321312
date-released: 2022-11-17
url: "https://github.com/IMMM-SFA/cerf"

GitHub Events

Total
  • Create event: 4
  • Issues event: 1
  • Watch event: 1
  • Delete event: 5
  • Issue comment event: 3
  • Member event: 1
  • Push event: 12
  • Pull request review comment event: 3
  • Pull request review event: 9
  • Pull request event: 7
  • Fork event: 2
Last Year
  • Create event: 4
  • Issues event: 1
  • Watch event: 1
  • Delete event: 5
  • Issue comment event: 3
  • Member event: 1
  • Push event: 12
  • Pull request review comment event: 3
  • Pull request review event: 9
  • Pull request event: 7
  • Fork event: 2

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 440
  • Total Committers: 4
  • Avg Commits per committer: 110.0
  • Development Distribution Score (DDS): 0.011
Past Year
  • Commits: 17
  • Committers: 2
  • Avg Commits per committer: 8.5
  • Development Distribution Score (DDS): 0.176
Top Committers
Name Email Commits
crvernon c****n@g****m 435
erexer 1****r 3
Nino Zuljevic n****c@p****v 1
Vernon d****0@w****v 1
Committer Domains (Top 20 + Academic)
we30658.pnl.gov: 1 pnnl.gov: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 40
  • Total pull requests: 74
  • Average time to close issues: 3 months
  • Average time to close pull requests: 20 days
  • Total issue authors: 6
  • Total pull request authors: 3
  • Average comments per issue: 0.68
  • Average comments per pull request: 0.69
  • Merged pull requests: 72
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 10
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 months
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.6
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • crvernon (12)
  • kmongird (11)
  • willu47 (10)
  • lisazeyen (4)
  • thurber (2)
  • erexer (1)
Pull Request Authors
  • crvernon (68)
  • erexer (11)
  • KristianNelson (1)
Top Labels
Issue Labels
enhancement (12) development (11) priority (6) documentation (1) tests (1) low priority (1) bug (1)
Pull Request Labels
enhancement (13) development (12) bug (4) tests (4) documentation (2) release (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 77 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 19
  • Total maintainers: 2
pypi.org: cerf

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

  • Documentation: https://immm-sfa.github.io/cerf
  • License: Copyright 2021 Battelle Memorial Institute Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Latest release: 2.4.0
    published over 1 year ago
  • Versions: 19
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 77 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 12.5%
Stargazers count: 15.6%
Average: 26.5%
Downloads: 27.2%
Dependent repos count: 67.1%
Maintainers (2)
crvernon kmongird
Last synced: 4 months ago

Dependencies

requirements.txt pypi
  • PyYAML >=5.4.1
  • fiona >=1.8.19
  • geopandas >=0.9.0
  • joblib >=1.0.1
  • matplotlib >=3.3.3
  • numpy >=1.19.4
  • pandas >=1.1.4
  • pyproj >=3.0.1
  • rasterio >=1.2.3
  • requests >=2.25.1
  • rtree >=0.9.7
  • seaborn >=0.11.1
  • shapely >=1.7.1
  • whitebox >=1.5.1
  • xarray >=0.16.1
setup.py pypi
  • PyYAML >=5.4.1
  • fiona >=1.8.19
  • geopandas >=0.9.0
  • joblib >=1.0.1
  • matplotlib >=3.3.3
  • numpy >=1.19.4
  • pandas >=1.1.4
  • pyproj >=3.0.1
  • rasterio >=1.2.3
  • requests >=2.25.1
  • rtree >=0.9.7
  • seaborn >=0.11.1
  • shapely >=1.7.1
  • whitebox >=1.5.1
  • xarray >=0.16.1
.github/workflows/build.yml actions
  • actions/checkout v1 composite
  • actions/setup-python master composite
  • codecov/codecov-action v1 composite
environment.yml pypi
  • PyYAML >=5.4.1
  • cerf *
  • fiona >=1.8.19
  • geopandas >=0.9.0
  • joblib >=1.0.1
  • matplotlib >=3.3.3
  • numpy >=1.19.4
  • pandas >=1.1.4
  • pyproj >=3.0.1
  • rasterio >=1.2.3
  • requests >=2.25.1
  • rtree >=0.9.7
  • seaborn >=0.11.1
  • shapely >=1.7.1
  • whitebox >=1.5.1
  • xarray >=0.16.1