Add examples that show other workflows to run H2I
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Start with the existing examples that load the overall configuration into the H2Integrate model, then trace how the three individual configurations can be loaded and passed as a dictionary. Add an example showing this alternative workflow, including changes made before initialization such as the recorder path, and verify that the example runs successfully.
Written by the indexing model from the issue text.
Description
We only show one workflow in most of the examples (load the overall config into H2Integrate model and run from there), and there are a lot of other ways that people can set up running H2I, especially when running a study.
One way is to load all the three individual configs first, change what you want to change, then instantiate H2Integrate with a dictionary instead of a yaml file.
This alternative workflow would be useful as some things are set when you initialize with the H2Integrate model and require extra work to be updated after that. For example, updating the recorder path would be easier before initialization rather than having to do the extra steps below:
- Dominant language
- Python
- Stars
- 30
- Forks
- 44
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 28
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from NatLabRockies/H2Integrate
-
infrastructure
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
NatLabRockies/H2Integrate#977 ·
Maintainers usually reply within 1 day
-
SimpleThermalNuclearReactorCostModel: variable O&M overstated 1000x (kWh treated as MWh)Possibly taken A pull request linked to this issue is open or already merged. Openbug finance
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
NatLabRockies/H2Integrate#968 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
NatLabRockies/H2Integrate#944 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
NatLabRockies/H2Integrate#894 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
NatLabRockies/H2Integrate#623 ·
Maintainers usually reply within 1 day
All issues in NatLabRockies/H2Integrate
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
BCDA-APS/polar-bits#93 ·
-
infer_audio_type only recognises one MPEG Layer III frame header, so most MP3 files are rejectedPossibly taken @Steve-20-ai claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
[BUG] - ssh_config `Match tagged` statement always appliesPossibly taken @AtharvRG claimed this today. OpenBug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
paramiko/paramiko#2715 · 1 comment ·
Maintainers usually reply within 9 days
-
auto-rejected intake mcp-intake needs-salvage priority:high type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Ikalus1988/MisakaNet#4221 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day