Science Score: 39.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 15 DOI reference(s) in README -
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary
Keywords
Repository
Demand Response Analysis Framework (DRAF)
Basic Info
Statistics
- Stars: 18
- Watchers: 2
- Forks: 4
- Open Issues: 1
- Releases: 6
Topics
Metadata Files
README.md
demand response analysis framework (draf) is an analysis and decision support framework for local multi-energy hubs focusing on demand response.
It uses the power of (mixed integer) linear programming optimization, pandas, Plotly, Matplotlib, elmada, GSEE, Jupyter and more to help users along the energy system analysis process.
The software is described and demonstrated in the open-access draf demo paper.
draf runs on Windows, macOS, and Linux.
A draf-version supporting time series aggregation is provided in the dev-TSA branch.
Features
- Time series analysis tools:
DemandAnalyzer- Analyze energy demand profilesPeakLoadAnalyzer- Analyze peak loads or run simple battery simulation
- Easily parameterizable component templates:
- battery energy storage (
BES), battery electric vehicle (BEV), combined heat and power (CHP), heat-only boiler (HOB), heat pump (HP), power-to-heat (P2H), photovoltaic (PV), wind turbine (WT), thermal energy storage (TES), fuel cell (FC), electrolyzer (Elc), hydrogen storage (H2S), production process (PP), product storage (PS), direct air capture (DAC), and more. - Sensible naming conventions for parameters and variables, see section Naming conventions.
- battery energy storage (
- Parameter preparation tools:
- Scenario generation tools: Easily build individual scenarios or sensitivity analyses
- Multi-objective mathematical optimization with support of different model languages and solvers:
Pyomo- A free and open-source modeling language in Python that supports multiple solvers.GurobiPy- The Python interface to Gurobi, the fastest MILP solver (see Mittelmann benchmark).
- Plotting tools: Convenient plotting of heatmaps, Sankeys, tables, pareto plots, etc. using
Plotly,Matplotlib, andseaborn.- Support of meta data such as
unit,doc,src, anddims - Automatic unit conversion
- Support of meta data such as
- Export tools:
CaseStudyobjects including all parameters, meta data, and results can be saved to files.- Data can be exported to xarray format.
Quick start
Open a terminal in the directory where you want to place
drafin.Clone
draf:
sh
git clone https://github.com/DrafProject/draf
cd draf
- Create and activate the
drafconda environment (conda env createwill create a conda environment based on environment.yml which will install the newest versions of the required packages including the full editable local version ofdraf.):
sh
conda env create
conda activate draf
- (OPTIONAL) If the draf environment caused issues, you could install an older but more specific conda environment, e.g.:
sh
conda env create --file environments/environment_py39all_mac.yml --force
conda activate draf39
(OPTIONAL) To use Gurobi (fast optimization), install a valid Gurobi license (its free for academics).
Open Jupyter notebook:
sh
jupyter notebook
Check if the imports work:
py import draf import elmada(OPTIONAL) To use the latest electricity prices and carbon emission factors from
elmada, request an ENTSO-E API key and set it to elmada:```py
You have to run this Python code only once (it writes to a permanent file):
import elmada elmada.setapikeys(entsoe="YOURENTSOEKEY") ```
Start modeling. Have a look at the examples. Start with the
minimalif you want to write your own component. Start with thePVexample if you want to import existing components. For more advanced modeling look at the drafdemocase_studies. Consider the DRAF CHEAT SHEET
Structure
A CaseStudy object can contain several Scenario instances:
Naming conventions
All parameter and variable names must satisfy the structure <Type>_<Component>_<Descriptor>_<Dims>.
E.g. in P_EG_buy_T, P is the entity type (here: electrical power), EG the component (here: Electricity Grid), buy the descriptor and T the dimension (here: time).
Dimensions are denoted with individual capital letters, so <Dims> is TE if the entity has the dimensions T and E.
See conventions.py for examples of types, components, and descriptors.
Contributing
Contributions in any form are welcome! Please contact Markus Fleschutz.
Citing
If you use draf for academic work please cite the draf demo paper:
bibtex
@article{Fleschutz2022,
author = {Markus Fleschutz and Markus Bohlayer and Marco Braun and Michael D. Murphy},
title = {Demand Response Analysis Framework ({DRAF}): An Open-Source Multi-Objective Decision Support Tool for Decarbonizing Local Multi-Energy Systems},
publisher = {{MDPI} {AG}},
journal = {Sustainability}
year = {2022},
volume = {14},
number = {13},
pages = {8025},
url = {https://doi.org/10.3390/su14138025},
doi = {10.3390/su14138025},
}
Publications using draf
- Fleschutz et al. (2023): Impact of Landing Interruptions on the Optimal Design and Operation of Green Hydrogen Hubs
- Fleschutz et al. (2023): From prosumer to flexumer: Case study on the value of flexibility in decarbonizing the multi-energy system of a manufacturing company (open access)
- Fleschutz et al. (2022): Industrial grid fees vs. demand response: A case study of a multi-use battery in a German chemical plant
- Fleschutz et al. (2022): Demand Response Analysis Framework (DRAF): An Open-Source Multi-Objective Decision Support Tool for Decarbonizing Local Multi-Energy Systems (open access)
- Fleschutz et al. (2021): The effect of price-based demand response on carbon emissions in European electricity markets: The importance of adequate carbon prices (open access)
- Fleschutz et al. (2017): Electricity Cost Reduction Potential of Industrial Processes using Real Time Pricing in a Production Planning Problem (open access)
License and status
Copyright (c) 2017-2024 Markus Fleschutz
License: LGPL v3
The development of draf was initiated by Markus Fleschutz in 2017 and continued in a cooperative PhD between the MeSSO Research Group of the Munster Technological University, Ireland and the Energy System Analysis Research Group of the Karlsruhe University of Applied Sciences, Germany.
This project was supported by the MTU Rísam PhD Scholarship scheme and by the Federal Ministry for Economic Affairs and Climate Action (BMWK) on the basis of a decision by the German Bundestag.
Thank you Dr. Markus Bohlayer, Dr. Ing. Adrian Bürger, Andre Leippi, Dr. Ing. Marco Braun, and Dr. Michael D. Murphy for your valuable feedback.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
GitHub Events
Total
- Watch event: 4
- Fork event: 1
Last Year
- Watch event: 4
- Fork event: 1
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| flma0001 | m****z@h****e | 186 |
| Markus Fleschutz | m****t@e****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 6
- Total pull requests: 1
- Average time to close issues: about 1 month
- Average time to close pull requests: 1 minute
- Total issue authors: 2
- Total pull request authors: 1
- Average comments per issue: 2.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- 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
- yamidibarra (3)
- mfleschutz (3)
Pull Request Authors
- mfleschutz (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
- Total downloads: unknown
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 20
proxy.golang.org: github.com/drafproject/draf
- Documentation: https://pkg.go.dev/github.com/drafproject/draf#section-documentation
- License: lgpl-3.0
-
Latest release: v0.3.1
published almost 3 years ago
Rankings
proxy.golang.org: github.com/DrafProject/draf
- Documentation: https://pkg.go.dev/github.com/DrafProject/draf#section-documentation
- License: lgpl-3.0
-
Latest release: v0.3.1
published almost 3 years ago
Rankings
Dependencies
- appdirs *
- elmada *
- geopy *
- gurobipy *
- holidays *
- matplotlib *
- numpy *
- pandas *
- pyomo >=5.7
- ray *
- seaborn *
- tabulate *
- tqdm *
- ephem
- geopy
- glpk
- ipython
- ipywidgets
- jupyter
- matplotlib
- numpy
- numpy-financial
- pandas
- pip
- plotly
- pvlib-python >=0.6.3
- pyomo
- python 3.9.*
- seaborn