NatLabRockies / NatLabRockies/H2Integrate
Showcase different methods of initializing H2IModel in examples
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 44
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 16
Description
Showcase different methods of initializing H2IModel in examples
Related to PR #313
Update examples to showcase different ways of initializing H2IModel, this would likely updating the python run scripts for examples and the top-level config files. All examples only showcase
- must change cwd to the example folder
- file paths in the top-level config are relative to the top-level config file and cwd
The ideas I have include:
- initializing H2I from a dictionary rather than a filepath
- Using !include in the top-level config for specifying file paths
- Specifying the full filepath to the top-level config
- Specifying the filepath to a custom model relative to the H2I package
Proposed solution
Alternatives considered
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 Python run scripts for the examples and the top-level config files mentioned in the issue. Check how cwd and relative paths are handled, then update the examples to demonstrate dictionary initialization, !include paths, full config paths, and custom model paths relative to the H2I package.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100