plutus

plutus: An R package to calculate electricity investments and stranded assets from the Global Change Analysis Model (GCAM) - Published in JOSS (2021)

https://github.com/jgcri/plutus

Science Score: 67.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    3 of 4 committers (75.0%) from academic institutions
  • Institutional organization owner
    Organization jgcri has institutional domain (www.pnnl.gov)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.7%) to scientific vocabulary

Scientific Fields

Engineering Computer Science - 60% confidence
Last synced: 6 months ago · JSON representation

Repository

Basic Info
Statistics
  • Stars: 5
  • Watchers: 8
  • Forks: 4
  • Open Issues: 4
  • Releases: 2
Created almost 5 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog Contributing License

README.md

docs build codecov DOI

plutus

Plutus is designed for GCAM v5.3 (excluding GCAM-USA).

Contents


Key Links

  • Github: https://github.com/JGCRI/plutus
  • Webpage: https://jgcri.github.io/plutus/

Back to Contents


Introduction

plutus post-processes outputs from the Global Change Analysis Model (GCAM) to calculate the electricity investment costs and stranded asset costs associated with GCAM projections of future power sector energy generation by technology.

Back to Contents


Citation

Zhao, M., Binsted, M., Wild, T.B., Khan, Z., Yarlagadda, B., Iyer, G., Vernon, C., Patel, P., Santos da Silva, S.R., Calvin, K.V., (2021). plutus - An R package to calculate electricity investments and stranded assets from the Global Change Analysis Model (GCAM). Journal of Open Source Software, 6(65), 3212, https://doi.org/10.21105/joss.03212

Back to Contents


Installation Guides

  1. Download and install:
- R (https://www.r-project.org/)
- R studio (https://www.rstudio.com/)
  1. For Linux users, install following libraries:

sudo apt install build-essential libcurl4-gnutls-dev libxml2-dev libssl-dev sudo apt-get install libxml2-dev

  1. Open R studio:

install.packages('devtools') devtools::install_github('JGCRI/rgcam') devtools::install_github('JGCRI/plutus')

  1. Metis installation

Metis provides functions to visualize the outputs from plutus. The installation guide for Metis can be accessed at Metis Github Page.

Back to Contents


How-to Guides

plutus::gcamInvest provides all-in-one workflow that reads gcamdata, processes queries, and estimates stranded assets and capital investments. Please visit the followings for detailed instructions.

Back to Contents


User Notice

  1. plutus is limited to GCAM v6 or earlier versions. plutus currently is not applicable to GCAM-USA.

  2. plutus currently does not include rooftop PV in the output because GCAM does not track rooftop PV carryover in each model time period. We are working on updating plutus to correctly represent new capacity installation and investment for rooftop PV.

  3. The new investment and capacity installation output for each time period from plutus are not on an annual basis. They are the total values during each 5-year GCAM time period.

Back to Contents


Owner

  • Name: Joint Global Change Research Institute
  • Login: JGCRI
  • Kind: organization
  • Location: College Park, MD, USA

Advancing fundamental understanding of human and Earth systems

GitHub Events

Total
  • Issues event: 2
  • Issue comment event: 1
Last Year
  • Issues event: 2
  • Issue comment event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 88
  • Total Committers: 4
  • Avg Commits per committer: 22.0
  • Development Distribution Score (DDS): 0.136
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
mengqi-z m****z@u****u 76
crvernon c****n@g****m 7
Zarrar Khan z****n@p****v 4
Pralit Patel p****l@p****v 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 12
  • Total pull requests: 15
  • Average time to close issues: 2 months
  • Average time to close pull requests: about 6 hours
  • Total issue authors: 8
  • Total pull request authors: 4
  • Average comments per issue: 1.42
  • Average comments per pull request: 0.13
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • samgdotson (3)
  • mengqi-z (2)
  • nurf004 (1)
  • amnmalik (1)
  • weilinleee (1)
  • Ishaan-ai39 (1)
  • Shukla02Nikita (1)
  • amygalanter (1)
Pull Request Authors
  • mengqi-z (12)
  • crvernon (1)
  • pralitp (1)
  • zarrarkhan (1)
Top Labels
Issue Labels
Pull Request Labels
publication (1)

Dependencies

.github/workflows/build.yml actions
  • actions/checkout v1 composite
  • r-lib/actions/setup-pandoc v2-branch composite
  • r-lib/actions/setup-r v2-branch composite
  • r-lib/actions/setup-tinytex v2-branch composite
.github/workflows/docs.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
.github/workflows/test_coverage.yml actions
  • actions/checkout v1 composite
  • r-lib/actions/setup-pandoc v2-branch composite
  • r-lib/actions/setup-r v2-branch composite
  • r-lib/actions/setup-tinytex v2-branch composite
DESCRIPTION cran
  • R >= 2.10 depends
  • XML >= 3.98 imports
  • data.table >= 1.14.0 imports
  • dplyr >= 1.0.4 imports
  • knitr >= 1.31 imports
  • magrittr >= 2.0.1 imports
  • rgcam * imports
  • testthat >= 3.0.2 imports
  • tibble >= 1.4.2 imports
  • tidyr >= 1.1.3 imports
  • xfun >= 0.21 imports
  • markdown * suggests
  • rmarkdown * suggests