idaholab / HERON

Holistic Energy Resource Optimization Network (HERON) is a modeling toolset and plugin for RAVEN to accelerate stochastic technoeconomic assessment of the economic viability of various grid-energy system configurations, especially with application to electrical grids and integrated energy systems (IES).
Apache License 2.0
22 stars 36 forks source link

[TASK] Better handling for common HERON data. #352

Closed joshua-cogliati-inl closed 3 months ago

joshua-cogliati-inl commented 3 months ago

Issue Description

From notes on a meeting for this:

The basic problems that we discussed were how distribute the workshop materials and the associated ROMs that are used by them.

Some questions related to this are

These need to work for three different cases:

For the git clone, the plan is that the ROMs will continue to be available in the clone. For the pip install and the standalone install these will need to be added. Since the current ROMs used by the workshop are significantly bigger than the HERON pip install, they will be a separate install. For the standalone install, the workshop materials and ROMs will be included.

In order to find the ROM data, we plan on first of all, moving the ROM data from various places in HERON/tests to HERON/data and adding a variable HERON_DATA (similar to the existing BASE_WORKING_DIR) that will point to HERON/data. If the environment variable HERON_DATA exists, it will use this for HERON_DATA. For git clones and the standalone install we will put logic in HERON so it can automatically find HERON/data. For pip installs, the user will have to manually set a HERON_DATA environment variable.


For Change Control Board: Issue Review

This review should occur before any development is performed as a response to this issue.


For Change Control Board: Issue Closure

This review should occur when the issue is imminently going to be closed.

PaulTalbot-INL commented 3 months ago

Good to close via #351.