PowerSimData

Simulation framework

https://github.com/Breakthrough-Energy/PowerSimData

Science Score: 33.0%

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

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    3 of 40 committers (7.5%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.5%) to scientific vocabulary

Keywords from Contributors

energy-system-model
Last synced: 10 months ago · JSON representation

Repository

Simulation framework

Basic Info
Statistics
  • Stars: 56
  • Watchers: 6
  • Forks: 42
  • Open Issues: 25
  • Releases: 13
Created over 7 years ago · Last pushed almost 3 years ago
Metadata Files
Readme License

README.md

logo

PyPI codecov made-with-python Code style: black Tests Documentation GitHub contributors GitHub commit activity GitHub last commit (branch) GitHub pull requests License: MIT Code of Conduct DOI Slack

PowerSimData

PowerSimData is part of a Python software ecosystem developed by Breakthrough Energy Sciences to carry out power flow study in the U.S. electrical grid.

Main Features

Here are a few things that PowerSimData can do: * Provide a flexible modeling tool to create complex scenarios * Perform investment cost studies * Run power flow study using interface to external simulation engine * Manage data throughout the lifecycle of a simulation

A detailed tutorial can be found on our docs.

Where to get it

  • Clone or Fork the source code on GitHub
  • Get latest release from PyPi: pip install powersimdata

Dependencies

PowerSimData relies on several Python packages all available on PyPi. The list can be found in the requirements.txt or Pipfile files both located at the root of this package.

Installation

To take full advantage of our software, we recommend that you clone/fork plug and follow the information therein to get our containerized framework up and running. A client/server installation is also possible and outlined in our Installation Guide. Either way, you will need a powerful solver, e.g. Gurobi, to run complex scenarios.

Only a limited set of features are available when solely installing PowerSimData. If you choose this option, we recommend that you use pipenv: sh pipenv sync pipenv shell since the dependencies will be installed in an isolated environment. It is of course possible to install the dependencies using the requirements file: sh pip install -r requirements.txt

License

MIT

Documentation

Code documentation in form of Python docstrings along with an overview of the package are available on our website.

Communication Channels

Sign up to our email list and our Slack workspace to get in touch with us.

Contributing

All contributions (bug report, documentation, feature development, etc.) are welcome. An overview on how to contribute to this project can be found in our Contribution Guide.

Owner

  • Name: Breakthrough Energy
  • Login: Breakthrough-Energy
  • Kind: organization

Open source software for a clean energy future

GitHub Events

Total
  • Watch event: 2
  • Fork event: 1
Last Year
  • Watch event: 2
  • Fork event: 1

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 1,570
  • Total Committers: 40
  • Avg Commits per committer: 39.25
  • Development Distribution Score (DDS): 0.764
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Ben RdO b****o@i****m 370
Jon Hagg j****g@b****g 218
Ben RdO b****l@b****g 200
Daniel Olsen d****n@b****g 192
Daniel Olsen d****n@i****m 106
danielolsen d****n@u****m 79
Jen Hagg j****n@b****g 59
Jon Hagg j****n@b****g 56
jon-hagg 6****g@u****m 52
BainanXia b****a@i****m 40
dmuldrew d****w@g****m 25
ahurli a****n@b****g 21
Jen Hägg 6****g@u****m 19
Lane Smith l****e@b****g 15
Lane Smith l****h@b****g 12
victoriahunt v****t@i****m 11
kasparm 1****m@u****m 10
BainanXia 5****a@u****m 10
Daniel Olsen d****l@b****g 10
Nina n****t@b****g 8
Fabian Hofmann f****f@g****e 7
dependabot[bot] 4****]@u****m 7
Vicky Hunt 4****t@u****m 6
jon-hagg j****g@i****m 6
Daniel Muldrew d****w@i****m 5
BainanXia b****a@b****g 4
Kaspar Mueller k****r@b****g 4
Merrielle Ondreicka m****e@u****m 3
Kaspar Mueller k****r@b****g 2
Merrielle Ondreicka m****a@i****m 2
and 10 more...

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 184
  • Total pull requests: 548
  • Average time to close issues: 3 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 16
  • Total pull request authors: 18
  • Average comments per issue: 1.76
  • Average comments per pull request: 2.2
  • Merged pull requests: 517
  • Bot issues: 0
  • Bot pull requests: 13
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • rouille (64)
  • danielolsen (58)
  • jenhagg (11)
  • ahurli (9)
  • victoriahunt (8)
  • dmuldrew (8)
  • kasparm (7)
  • lanesmith (5)
  • BainanXia (5)
  • LFPower (2)
  • Mingze-Li128 (2)
  • yixingxu (1)
  • ghost (1)
  • zacharyDez (1)
  • chrstphtrs (1)
Pull Request Authors
  • danielolsen (156)
  • jenhagg (144)
  • rouille (128)
  • dmuldrew (25)
  • BainanXia (20)
  • ghost (14)
  • FabianHofmann (13)
  • dependabot[bot] (11)
  • kasparm (9)
  • ahurli (6)
  • merrielle (6)
  • lanesmith (5)
  • goccert25 (3)
  • ywang303 (2)
  • c-voegele (1)
Top Labels
Issue Labels
feature request (44) bug (33) new feature (33) refactor (23) Epic (12) data collection (9) documentation (7) CEM (2) good first issue (1)
Pull Request Labels
bug (56) refactor (37) new feature (33) documentation (27) dependencies (21) feature request (4) CEM (3) data collection (3) data intake (1)

Packages

  • Total packages: 3
  • Total downloads:
    • pypi 3,155 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 6
    (may contain duplicates)
  • Total versions: 33
  • Total maintainers: 2
proxy.golang.org: github.com/breakthrough-energy/powersimdata
  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
proxy.golang.org: github.com/Breakthrough-Energy/PowerSimData
  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
pypi.org: powersimdata

Power Simulation Data

  • Versions: 9
  • Dependent Packages: 1
  • Dependent Repositories: 6
  • Downloads: 3,155 Last month
Rankings
Dependent packages count: 3.2%
Dependent repos count: 6.1%
Forks count: 6.5%
Stargazers count: 9.6%
Average: 14.2%
Downloads: 45.7%
Maintainers (2)
Last synced: 10 months ago

Dependencies

.github/workflows/coverage.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v1 composite
.github/workflows/external.yml actions
  • Breakthrough-Energy/actions/workflow-trigger main composite
.github/workflows/lint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/release.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
Dockerfile docker
  • python 3.8.3 build
docker-compose.yml docker
  • powersimdata latest
Pipfile pypi
  • black * develop
  • coverage * develop
  • pytest * develop
  • pytest-cov * develop
  • fs ==2.4.14
  • fs-azureblob >=0.2.1
  • fs.sshfs *
  • networkx ~=2.5
  • numpy ~=1.20
  • pandas ~=1.2
  • paramiko ~=2.12
  • pypsa *
  • requests ~=2.25
  • scipy ~=1.5
  • tqdm ==4.29.1
Pipfile.lock pypi
  • attrs ==22.2.0 develop
  • black ==23.1.0 develop
  • click ==8.1.3 develop
  • coverage ==7.1.0 develop
  • exceptiongroup ==1.1.0 develop
  • iniconfig ==2.0.0 develop
  • mypy-extensions ==1.0.0 develop
  • packaging ==23.0 develop
  • pathspec ==0.11.0 develop
  • platformdirs ==3.0.0 develop
  • pluggy ==1.0.0 develop
  • pytest ==7.2.1 develop
  • pytest-cov ==4.0.0 develop
  • tomli ==2.0.1 develop
  • typing-extensions ==4.4.0 develop
  • appdirs ==1.4.4
  • azure-core ==1.26.3
  • azure-storage-blob ==12.15.0b1
  • azure-storage-file-datalake ==12.10.0b1
  • bcrypt ==4.0.1
  • blosc2 ==2.0.0
  • bottleneck ==1.3.7rc1
  • certifi ==2022.12.7
  • cffi ==1.15.1
  • cftime ==1.6.2
  • charset-normalizer ==3.0.1
  • click ==8.1.3
  • cloudpickle ==2.2.1
  • contourpy ==1.0.7
  • cryptography ==39.0.1
  • cycler ==0.11.0
  • cython ==3.0.0a11
  • dask ==2023.1.1
  • deprecation ==2.1.0
  • fonttools ==4.38.0
  • fs ==2.4.14
  • fs-azureblob ==0.2.1
  • fs.sshfs ==1.0.1
  • fsspec ==2023.1.0
  • idna ==3.4
  • importlib-resources ==5.10.2
  • isodate ==0.6.1
  • kiwisolver ==1.4.4
  • linopy ==0.1.3
  • locket ==1.0.0
  • matplotlib ==3.7.0rc1
  • msgpack ==1.0.5rc1
  • netcdf4 ==1.6.2
  • networkx ==2.8.8
  • numexpr ==2.8.4
  • numpy ==1.24.2
  • packaging ==23.0
  • pandas ==1.5.3
  • paramiko ==2.12.0
  • partd ==1.3.0
  • pillow ==9.4.0
  • ply ==3.11
  • property-cached ==1.6.4
  • py-cpuinfo ==9.0.0
  • pycparser ==2.21
  • pynacl ==1.5.0
  • pyomo ==6.4.4
  • pyparsing ==3.0.9
  • pypsa ==0.22.0
  • python-dateutil ==2.8.2
  • pytz ==2022.7.1
  • pyyaml ==6.0
  • requests ==2.28.2
  • scipy ==1.10.0
  • setuptools ==67.2.0
  • six ==1.16.0
  • tables ==3.8.0
  • toolz ==0.12.0
  • tqdm ==4.29.1
  • typing-extensions ==4.4.0
  • urllib3 ==1.26.14
  • xarray ==2023.2.0
  • zipp ==3.12.1
optional-requirements.txt pypi
  • fiona *
  • gdal *
  • geopandas *
  • matplotlib ==3.2.1
  • psycopg2 *
  • rtree *
  • shapely ==1.7.1
requirements.txt pypi
  • black *
  • coverage *
  • fs ==2.4.14
  • fs-azureblob >=0.2.1
  • fs.sshfs *
  • networkx *
  • numpy *
  • pandas *
  • paramiko *
  • pypsa *
  • pytest *
  • pytest-cov *
  • requests *
  • scipy *
  • tqdm ==4.29.1
setup.py pypi