NatLabRockies / NatLabRockies/H2Integrate
Handle references and citations well
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 44
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 16
Description
Handle references and citations well
Each technology included in an H2I simulation might be based on different references.
We should have some way of making it clear to users what references were used in their simulation.
Proposed solution
We could have an attribute within each technology's performance, cost, and financial models called references (or similar) which contains the bibtex info for each reference.
See here for a slightly different example within OpenMDAO.
Then, as a postprocessing step we could loop through each of the techs and collect the references, then output a .bib file with all the references accordingly.
Alternatives considered
At a minimum, we should make sure that the docstrings for the technologies are up-to-date with the references used.
Additional context
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the performance, cost, and financial models for each technology, then trace the postprocessing step that collects technology data. Define how references should be stored and ensure a simulation can produce a .bib file containing the used citations; at minimum, verify that technology docstrings stay current.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100