dispatches
Primary repository for distributed dispatches software tools
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
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
3 of 19 committers (15.8%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (17.3%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Primary repository for distributed dispatches software tools
Basic Info
- Host: GitHub
- Owner: gmlc-dispatches
- License: other
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://dispatches.readthedocs.io/
- Size: 23.5 MB
Statistics
- Stars: 15
- Watchers: 6
- Forks: 36
- Open Issues: 15
- Releases: 5
Topics
Metadata Files
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:
sh
conda create -n dispatches-dev python=3.8 pip --yes
conda activate dispatches-dev
Clone the repository and enter the dispatches directory:
sh
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:
sh
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:
sh
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:
sh
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
- Name: DISPATCHES
- Login: gmlc-dispatches
- Kind: organization
- Repositories: 3
- Profile: https://github.com/gmlc-dispatches
Design Integration and Synthesis Platform to Advance Tightly Coupled Hybrid Energy Systems
GitHub Events
Total
- Watch event: 3
- Fork event: 3
Last Year
- Watch event: 3
- Fork event: 3
Committers
Last synced: 7 months ago
Top Committers
| 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 (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- 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 requests: 54
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: 25 minutes
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.5
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- lbianchi-lbl (19)
- adowling2 (9)
- radhakrishnatg (4)
- jghouse88 (3)
- adam-a-a (3)
- Xinhe-Chen (3)
- dguittet (2)
- MarcusHolly (1)
- nareshsusarla (1)
- xiangao1 (1)
- dangunter (1)
- PaulTalbot-INL (1)
Pull Request Authors
- lbianchi-lbl (20)
- dguittet (17)
- nareshsusarla (11)
- radhakrishnatg (10)
- Xinhe-Chen (10)
- bknueven (4)
- ksbeattie (2)
- adam-a-a (2)
- xiangao1 (1)
- MarcusHolly (1)
- GabrielSoto-INL (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 30 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/
- License: BSD License
-
Latest release: 1.2.0
published almost 3 years ago
Rankings
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