DISPATCHES
Developed and used to identify and optimize Integrated Energy Systems for operation within the bulk power system via energy market signals.
https://github.com/gmlc-dispatches/dispatches
Category: Energy Systems
Sub Category: Grid Analysis and Planning
Keywords
idaesplus
Keywords from Contributors
process-modeling chemical-engineering process-systems-engineering idaes-pse pse training feature-toggle feature-flag featured control
Last synced: about 20 hours ago
JSON representation
Repository metadata
Primary repository for distributed dispatches software tools
- Host: GitHub
- URL: https://github.com/gmlc-dispatches/dispatches
- Owner: gmlc-dispatches
- License: other
- Created: 2020-12-21T20:32:55.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T20:20:12.000Z (8 months ago)
- Last Synced: 2025-04-25T18:37:30.415Z (2 days ago)
- Topics: idaesplus
- Language: Jupyter Notebook
- Homepage: https://dispatches.readthedocs.io/
- Size: 23.5 MB
- Stars: 15
- Watchers: 6
- Forks: 34
- Open Issues: 15
- Releases: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
README.md
DISPATCHES
The Design Integration and Synthesis Platform to Advance Tightly Coupled Hybrid Energy Systems (DISPATCHES),
is developed and used to identify and optimize Integrated Energy Systems for operation within the bulk power system via energy market signals.
DISPATCHES is part of the DOE Grid Modernization Laboratory Consortium (GMLC).
Project Status
Getting started
Example notebooks
The example notebooks showcase many of DISPATCHES' features and capabilities.
The example notebooks can be accessed in several ways:
- In the Examples section of the DISPATCHES online documentation on ReadTheDocs
- Interactively, in a temporary cloud environment, following the steps illustrated in the Binder README in this repository
Using Conda environments
The recommended way to install DISPATCHES is to use a Conda environment.
A Conda environment is a separate installation directory where packages and even different Python versions can be installed
without conflicting with other Python versions installed on the system, or other environments.
To create a Conda environment, the conda
command should be installed and configured for your operating system.
Detailed steps to install and configure conda
are available here.
For developers
(Recommended) Create a dedicated Conda environment for development work:
conda create -n dispatches-dev python=3.8 pip --yes
conda activate dispatches-dev
Clone the repository and enter the dispatches
directory:
git clone https://github.com/gmlc-dispatches/dispatches
cd dispatches
Install the Python package and all dependencies required for development work using pip and the requirements-dev.txt
file:
pip install -r requirements-dev.txt
The developer installation will install the cloned directory in editable mode (as opposed to the default behavior of installing a copy of it),
which means that any modification made to the code in the cloned directory
(including switching to a different branch with git switch
/git checkout
, or updating the repository with the latest changes using git pull
) will be available when using the package in Python,
regardless of e.g. the current working directory.
To test that the installation was successful, run the test suite using the pytest
command:
pytest
As a developer, to ensure that all the .py files in your workspace have the correct copyright header
info (as defineded in header_text.txt
), use the addheader
tool installed by requirements-dev.txt
as follows:
addheader -c .addheader.yml
Documentation
For showing documentation from your code in the Sphinx (.rst) docs, see the Sphinx autodoc documentation for details on how to format and give options in your documentation file.
Funding acknowledgements
This work was conducted as part of the Design Integration and Synthesis Platform to Advance Tightly
Coupled Hybrid Energy Systems (DISPATCHES) project with support through the Grid Modernization Lab
Consortium with funding from the U.S.
Department of Energy’s Office of Fossil Energy and Carbon Management,
Office of Nuclear Energy, and Hydrogen and Fuel Cell Technology Office.
Owner metadata
- Name: DISPATCHES
- Login: gmlc-dispatches
- Email:
- Kind: organization
- Description: Design Integration and Synthesis Platform to Advance Tightly Coupled Hybrid Energy Systems
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/68717224?v=4
- Repositories: 3
- Last ynced at: 2023-03-06T02:41:55.542Z
- Profile URL: https://github.com/gmlc-dispatches
GitHub Events
Total
- Watch event: 2
- Fork event: 1
Last Year
- Watch event: 2
- Fork event: 1
Committers metadata
Last synced: 6 days ago
Total Commits: 359
Total Committers: 19
Avg Commits per committer: 18.895
Development Distribution Score (DDS): 0.588
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 | |
---|---|---|
dguittet | d****t@n****v | 148 |
Naresh Susarla | s****n@a****e | 36 |
Ludovico Bianchi | l****i@l****v | 31 |
jghouse88 | 28 | |
Keith Beattie | K****e@l****v | 28 |
Radhakrishna T G | r****g@g****m | 24 |
klfrick2 | 4****2 | 13 |
Dan Gunter | d****r@l****v | 11 |
Naresh | 4****a | 11 |
jghouse88 | j****e@n****v | 6 |
John Siirola | j****a | 5 |
Konica Mulani | k****i@T****l | 4 |
Xian Gao | 3****1 | 3 |
Xinhe Chen | 9****n | 3 |
bknueven | 3****n | 3 |
Adam Atia | a****a@k****m | 2 |
Alex Dowling | a****x@d****g | 1 |
Andres J Calderon | a****9@h****m | 1 |
Andrew Lee | a****e@n****v | 1 |
Committer domains:
- lbl.gov: 3
- netl.doe.gov: 2
- dowlinglab.org: 1
- keylogic.com: 1
- ad.science: 1
- nrel.gov: 1
Issue and Pull Request metadata
Last synced: 2 days ago
Total issues: 49
Total pull requests: 80
Average time to close issues: 5 months
Average time to close pull requests: about 2 months
Total issue authors: 12
Total pull request authors: 11
Average comments per issue: 3.55
Average comments per pull request: 3.83
Merged pull request: 54
Bot issues: 0
Bot pull requests: 0
Past year issues: 0
Past year pull requests: 2
Past year average time to close issues: N/A
Past year average time to close pull requests: 25 minutes
Past year issue authors: 0
Past year pull request authors: 1
Past year average comments per issue: 0
Past year average comments per pull request: 0.5
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- lbianchi-lbl (19)
- adowling2 (10)
- radhakrishnatg (4)
- jghouse88 (3)
- adam-a-a (3)
- Xinhe-Chen (3)
- dguittet (2)
- MarcusHolly (1)
- nareshsusarla (1)
- xiangao1 (1)
- dangunter (1)
- PaulTalbot-INL (1)
Top Pull Request Authors
- lbianchi-lbl (21)
- dguittet (18)
- nareshsusarla (12)
- radhakrishnatg (10)
- Xinhe-Chen (8)
- bknueven (4)
- ksbeattie (2)
- adam-a-a (2)
- xiangao1 (1)
- GabrielSoto-INL (1)
- MarcusHolly (1)
Top Issue Labels
- Priority:High (31)
- Priority:Normal (16)
- IDAES (4)
- Discussion (3)
- bug (3)
- documentation (2)
- Priority:Low (1)
- enhancement (1)
- Final Report (1)
Top Pull Request Labels
- Priority:High (55)
- Priority:Normal (17)
- Final Report (4)
- Priority:Low (2)
- enhancement (2)
- dependencies (2)
- RAVEN (1)
- TEAL (1)
- bug (1)
- documentation (1)
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 423 last-month
- Total dependent packages: 1
- Total dependent repositories: 1
- Total versions: 10
- Total maintainers: 2
pypi.org: dispatches
GMLC DISPATCHES software tools
- Homepage: https://github.com/gmlc-dispatches/dispatches
- Documentation: https://dispatches.readthedocs.io/
- Licenses: BSD License
- Latest release: 1.2.0 (published about 2 years ago)
- Last Synced: 2025-04-25T18:31:49.921Z (2 days ago)
- Versions: 10
- Dependent Packages: 1
- Dependent Repositories: 1
- Downloads: 423 Last month
-
Rankings:
- Dependent packages count: 4.766%
- Forks count: 7.222%
- Average: 18.979%
- Stargazers count: 19.325%
- Dependent repos count: 21.615%
- Downloads: 41.968%
- Maintainers (2)
Dependencies
- addheader *
- pytest-cov *
- sphinx *
- sphinx-rtd-theme *
- SPECIAL_DEPENDENCIES *
- for *
- graphviz *
- gridx-prescient >=2.1
- jupyter *
- nrel-pysam >=3.0.1
- pytest *
- we *
- actions/checkout v2 composite
- actions/setup-python v2 composite
- codecov/codecov-action v2 composite
- conda-incubator/setup-miniconda v2 composite
- actions/checkout v2 composite
- actions/setup-python v2 composite
- gmlc-dispatches/nbcheck 0.1.12 composite
- dispatches-sample-data ==22.06.28
- actions/setup-python v4 composite
- conda-incubator/setup-miniconda v2 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
Score: 12.40242037405722