bslib
Database with battery parameters based on PerMod as well as functions in order to simulate battery storages.
https://github.com/FZJ-IEK3-VSA/bslib
Category: Energy Storage
Sub Category: Battery
Keywords
battery energy simulation
Keywords from Contributors
heatpump
Last synced: about 21 hours ago
JSON representation
Repository metadata
Database with battery parameters based on PerMod (HTW Berlin) as well as functions in order to simulate battery storages (manufacturer+model or generic type)
- Host: GitHub
- URL: https://github.com/FZJ-IEK3-VSA/bslib
- Owner: FZJ-IEK3-VSA
- License: mit
- Created: 2021-09-22T13:32:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-18T07:46:55.000Z (over 2 years ago)
- Last Synced: 2025-04-17T22:07:13.096Z (9 days ago)
- Topics: battery, energy, simulation
- Language: Python
- Homepage:
- Size: 919 KB
- Stars: 11
- Watchers: 4
- Forks: 5
- Open Issues: 0
- Releases: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
README.md
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 |
---|---|
[S_ac]: 2 | AC-coupled |
[S_dc]: 3 | DC-coupled |
[INV]: 2 | PV Inverter |
Database
All resulting database CSV file are under .
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
Owner metadata
- Name: Forschungszentrum Jülich - Jülich Systems Analysis
- Login: FZJ-IEK3-VSA
- Email:
- Kind: organization
- Description: Institute of Climate and Energy Systems (ICE)
- Website: https://www.fz-juelich.de/iek/iek-3/EN/Home/home_node.html
- Location: Forschungszentrum Jülich
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/28654423?v=4
- Repositories: 16
- Last ynced at: 2024-12-23T04:12:17.721Z
- Profile URL: https://github.com/FZJ-IEK3-VSA
GitHub Events
Total
- Watch event: 2
Last Year
- Watch event: 2
Committers metadata
Last synced: 6 days ago
Total Commits: 124
Total Committers: 4
Avg Commits per committer: 31.0
Development Distribution Score (DDS): 0.242
Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0
Name | Commits | |
---|---|---|
Kai Rösken | k****1@g****m | 94 |
Tjarko Tjaden | t****n@g****m | 23 |
Hauke Hoops | 7****i | 6 |
Julian Schönau | 6****e | 1 |
Committer domains:
Issue and Pull Request metadata
Last synced: 2 days ago
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 request: 4
Bot issues: 0
Bot pull requests: 0
Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- fastrockstar (2)
Top Pull Request Authors
- ttjaden (1)
- fastrockstar (1)
- xihaui (1)
- OfficialCodexplosive (1)
Top Issue Labels
Top Pull Request Labels
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 1,274 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.
- Homepage: https://github.com/FZJ-IEK3-VSA/bslib
- Documentation: https://bslib.readthedocs.io/
- Licenses: MIT
- Latest release: 0.0.0 (published almost 3 years ago)
- Last Synced: 2025-04-25T12:30:29.967Z (2 days ago)
- Versions: 6
- Dependent Packages: 1
- Dependent Repositories: 8
- Downloads: 1,274 Last month
-
Rankings:
- Dependent packages count: 3.271%
- Dependent repos count: 5.278%
- Downloads: 7.089%
- Average: 9.691%
- Forks count: 14.287%
- Stargazers count: 18.529%
- Maintainers (1)
Dependencies
- numba *
- numpy *
- pandas *
- pip *
- ipykernel *
- ipython_genutils *
- jupyter *
- numba *
- numpy *
- openpyxl *
- pandas *
- pip *
- versioneer *
- numpy *
- pandas *
- actions/checkout v2 composite
- actions/setup-python v2 composite
- pypa/gh-action-pypi-publish master composite
Score: 10.941925118168168