NatLabRockies / NatLabRockies/H2Integrate

Add examples that show other workflows to run H2I

Open
#877 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
26
Forks
44
Avg merge
3d 22h
Merged PRs (30d)
16

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:

Image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.