bslib

Database with battery parameters based on PerMod (HTW Berlin) as well as functions in order to simulate battery storages (manufacturer+model or generic type)

https://github.com/FZJ-IEK3-VSA/bslib

Science Score: 23.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 7 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (17.9%) to scientific vocabulary

Keywords

battery energy simulation

Keywords from Contributors

heatpump
Last synced: 9 months ago · JSON representation

Repository

Database with battery parameters based on PerMod (HTW Berlin) as well as functions in order to simulate battery storages (manufacturer+model or generic type)

Basic Info
  • Host: GitHub
  • Owner: FZJ-IEK3-VSA
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 919 KB
Statistics
  • Stars: 11
  • Watchers: 4
  • Forks: 5
  • Open Issues: 0
  • Releases: 0
Topics
battery energy simulation
Created over 4 years ago · Last pushed over 3 years ago
Metadata Files
Readme License

README.md

DOI

FZJ Logo

bslib - battery storage library

Repository with code to

  • build a database with relevant data from PerMod database (HTW Berlin) and "Stromspeicher-Inspektion"
  • simulate ac- and dc-coupled battery storages with regards to electrical power (ac and dc) and state-of-charge as timeseries.

For the simulation, it is possible to calculate outputs of a specific manufacturer + model or alternatively for one of 2 different generic battery storage types.

For reference purposes: - DOI: https://doi.org/10.5281/zenodo.6514527 - Citation: Kai Rösken, Tjarko Tjaden, & Hauke Hoops. (2022). FZJ-IEK3-VSA/bslib: v0.7. Zenodo. https://doi.org/10.5281/zenodo.6514527

Documentation

The documentation is still under development.

Usage

Simply install via

  • pip install bslib

or clone repository and create environment via:

  • git clone https://github.com/FZJ-IEK3-VSA/bslib.git
  • conda env create --name bslib --file requirements.txt

Afterwards you're able to create some code with import bslib and use the included functions load_database, get_parameters and simulate.

Battery models and Group IDs

The bslib_database.csv contains the following number of battery storages, sorted by Group ID

| [Group ID]: Count | Description | | :--- | :--- | | [Sac]: 2 | AC-coupled | | [Sdc]: 3 | DC-coupled | | [INV]: 2 | PV Inverter |

Database

All resulting database CSV file are under License: CC BY 4.0.

The following columns are available for every battery storage of this library

| Column | Description | Comment | | :--- | :--- | :--- | | .. | .. | .. |

Input-Data and further development

If you find errors or are interested in develop the bslib, please create an ISSUE and/or FORK this repository and create a PULL REQUEST.

License

MIT License

Copyright (c) 2022

You should have received a copy of the MIT License along with this program. If not, see https://opensource.org/licenses/MIT

About Us

Institut TSA

We are the Institute of Energy and Climate Research - Techno-economic Systems Analysis (IEK-3) belonging to the Forschungszentrum Jülich. Our interdisciplinary department's research is focusing on energy-related process and systems analyses. Data searches and system simulations are used to determine energy and mass balances, as well as to evaluate performance, emissions and costs of energy systems. The results are used for performing comparative assessment studies between the various systems. Our current priorities include the development of energy strategies, in accordance with the German Federal Government’s greenhouse gas reduction targets, by designing new infrastructures for sustainable and secure energy supply chains and by conducting cost analysis studies for integrating new technologies into future energy market frameworks.

Owner

  • Name: Forschungszentrum Jülich - Jülich Systems Analysis
  • Login: FZJ-IEK3-VSA
  • Kind: organization
  • Location: Forschungszentrum Jülich

Institute of Climate and Energy Systems (ICE)

GitHub Events

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

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 124
  • Total Committers: 4
  • Avg Commits per committer: 31.0
  • Development Distribution Score (DDS): 0.242
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Kai Rösken k****1@g****m 94
Tjarko Tjaden t****n@g****m 23
Hauke Hoops 7****i@u****m 6
Julian Schönau 6****e@u****m 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 2
  • Total pull requests: 4
  • Average time to close issues: 19 days
  • Average time to close pull requests: 13 days
  • Total issue authors: 1
  • Total pull request authors: 4
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
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
  • fastrockstar (2)
Pull Request Authors
  • fastrockstar (1)
  • xihaui (1)
  • OfficialCodexplosive (1)
  • ttjaden (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,192 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 8
  • Total versions: 6
  • Total maintainers: 1
pypi.org: bslib

A library for simulating PV battery storage systems.

  • Versions: 6
  • Dependent Packages: 1
  • Dependent Repositories: 8
  • Downloads: 1,192 Last month
Rankings
Dependent packages count: 3.3%
Dependent repos count: 5.3%
Downloads: 7.1%
Average: 9.7%
Forks count: 14.3%
Stargazers count: 18.5%
Maintainers (1)
Last synced: 9 months ago

Dependencies

docs/requirements.txt pypi
  • numba *
  • numpy *
  • pandas *
  • pip *
requirements.txt pypi
  • ipykernel *
  • ipython_genutils *
  • jupyter *
  • numba *
  • numpy *
  • openpyxl *
  • pandas *
  • pip *
  • versioneer *
setup.py pypi
  • numpy *
  • pandas *
.github/workflows/python-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish master composite