NatLabRockies / NatLabRockies/H2Integrate
Standardize and streamline output directories
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 26
- Forks
- 44
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 16
Description
Standardize and streamline output directories
When running an H2I case, a few directories are created, including:
- an OpenMDAO output folder, e.g.
run_wind_wave_doc_outif the file ran is calledrun_wind_wave_doc.py - a
logfolder - a
cachefolder if HOPP is used with caching - any folders created by certain technologies, e.g.
output
Proposed solution
We should probably have a singular folder for output to make it clear where results are stored.
It might make sense to put all outputted files in the automatically-generated by OpenMDAO folder as it already contains a reports subfolder.
Depending on the number of technologies used there could be a big folder mess -- let's avoid that.
What's the most intuitive 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 running an H2I case such as run_wind_wave_doc.py and inventory the OpenMDAO output, log, cache, and technology-specific output directories. Review how OpenMDAO and HOPP create these locations, then define the expected single-directory layout and confirm that all generated results remain accessible there.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100