Merge pull request #728 from RHammond2/feature/simplified-imports

Feature: Create Package-Level Imports For Basic Objects

Author: johnjasa

CHANGELOG.md

@@ -18,6 +18,7 @@
 - Rename `n_control_window` to `n_control_window_hours` for unit clarity [PR 712](https://github.com/NatLabRockies/H2Integrate/pull/712)
 - Update N2 diagram for demand openloop control from static and outdated to dynamic and interactive [PR 714](https://github.com/NatLabRockies/H2Integrate/pull/714)
 - Added basic check of 4-length connections in `technology_interconnections` [PR 720](https://github.com/NatLabRockies/H2Integrate/pull/720)
+- Adds `H2IntegrateModel`, `load_yaml`, `write_yaml`, and `write_readable_yaml` as package-level imports [PR 728](https://github.com/NatLabRockies/H2Integrate/pull/728).
 - Update N2 diagram for Pyomo heuristic control from static image to dynamic and interactive embedded diagram [PR 726](https://github.com/NatLabRockies/H2Integrate/pull/726)
 - Added ability to use timeseries for finance calculations [PR 725](https://github.com/NatLabRockies/H2Integrate/pull/725)
 

docs/_static/class_hierarchy.html

@@ -15,10 +15,10 @@ kernelspec:
 
 ```{code-cell} ipython3
 from pathlib import Path
+
 from matplotlib import pyplot as plt
-from h2integrate.core.h2integrate_model import H2IntegrateModel
-from h2integrate import EXAMPLE_DIR
 
+from h2integrate import H2IntegrateModel, EXAMPLE_DIR
 ```
 
 ## Hydrogen Dispatch

docs/control/controller_demonstrations.md

@@ -40,7 +40,7 @@ Open `h2i_n2.html` in a browser to explore model groups, components, and variabl
 ```{code-cell} ipython3
 :tags: [remove-input]
 
-from h2integrate.core.h2integrate_model import H2IntegrateModel
+from h2integrate import H2IntegrateModel
 import openmdao.api as om
 import os
 

docs/control/open-loop_controllers.md

@@ -68,16 +68,13 @@ We don't want to send more electricity to the electrolyzer than the electrolyzer
 :lines: 112-119
 ```
 
-
-
 We initialize and setup the H2I model
 
 ```{code-cell} ipython3
 from pathlib import Path
 from matplotlib import pyplot as plt
-from h2integrate.core.h2integrate_model import H2IntegrateModel
-from h2integrate import EXAMPLE_DIR
-from h2integrate.core.inputs.validation import load_tech_yaml, load_plant_yaml, load_driver_yaml
+
+from h2integrate import H2IntegrateModel, EXAMPLE_DIR, load_tech_yaml, load_plant_yaml, load_driver_yaml
 
 ex_dir = EXAMPLE_DIR / "13_dispatch_for_electrolyzer"
 tech_config = load_tech_yaml(ex_dir / "tech_config.yaml")

docs/demand/demand_demo.md

@@ -34,14 +34,11 @@ We'll start off by importing the required modules and packages:
 
 ```{code-cell} ipython3
 import os
-import numpy as np
 
+import numpy as np
 
-from h2integrate import EXAMPLE_DIR
-from h2integrate.core.file_utils import load_yaml
-from h2integrate.core.inputs.validation import load_tech_yaml
+from h2integrate import H2IntegrateModel, EXAMPLE_DIR, load_yaml, write_readable_yaml, load_tech_yaml
 from h2integrate.preprocess.wind_turbine_file_tools import export_turbine_to_pysam_format
-from h2integrate.core.h2integrate_model import H2IntegrateModel
 ```
 
 Load the tech config file that we want to update the turbine model for:
@@ -126,8 +123,6 @@ print(f"LCOH is ${lcoh[0]:.2f}/kg")
 ### Option 2: Save new tech_config to file and run H2I from file
 
 ```{code-cell} ipython3
-from h2integrate.core.file_utils import write_readable_yaml
-
 # Define a new filepath for the updated tech config
 tech_config_path_new = EXAMPLE_DIR / "08_wind_electrolyzer" / f"tech_config_{turbine_name}.yaml"
 

docs/misc_resources/turbine_models_library_preprocessing.md

@@ -20,7 +20,7 @@ Resource data for a technology can be set using the `set_val()` command. In the
 
 ```python
 import pandas as pd
-from h2integrate.core.h2integrate_model import H2IntegrateModel
+from h2integrate import H2IntegrateModel
 # Create an H2I model
 h2i = H2IntegrateModel("07_run_of_river.yaml")
 

docs/resource/resource_index.md

@@ -154,10 +154,9 @@ Next, we'll import the required models and functions to complete run a successfu
 # Import necessary methods and packages
 from pathlib import Path
 
+from h2integrate import H2IntegrateModel, load_driver_yaml, write_yaml
 from h2integrate.core.file_utils import check_file_format_for_csv_generator, load_yaml
 from h2integrate.core.dict_utils import update_defaults
-from h2integrate.core.h2integrate_model import H2IntegrateModel
-from h2integrate.core.inputs.validation import load_driver_yaml, write_yaml
 ```
 
 ##### Setup and first attempt

docs/user_guide/design_of_experiments_in_h2i.md

@@ -46,7 +46,7 @@ An example is shown in `run_ammonia_synloop.py`:
 from pathlib import Path
 
 from h2integrate.tools.run_cases import modify_tech_config, load_tech_config_cases
-from h2integrate.core.h2integrate_model import H2IntegrateModel
+from h2integrate import H2IntegrateModel
 
 
 # Create a H2Integrate model

docs/user_guide/how_to_run_several_cases_in_sequence.md

@@ -133,9 +133,10 @@ Use the built-in `create_xdsm()` method to generate a static system diagram from
 `technology_interconnections` section of your plant config.
 
 ```python
-from h2integrate.core.h2integrate_model import H2IntegrateModel
 import os
 
+from h2integrate import H2IntegrateModel
+
 
 # Change to an example directory
 os.chdir("../../examples/08_wind_electrolyzer/")
@@ -160,10 +161,12 @@ This creates a PDF named `connections_xdsm.pdf` in your current working director
 Use OpenMDAO's `n2` utility to generate an interactive HTML diagram of the full model.
 
 ```{code-cell} ipython3
-from h2integrate.core.h2integrate_model import H2IntegrateModel
-import openmdao.api as om
 import os
 
+import openmdao.api as om
+
+from h2integrate import H2IntegrateModel
+
 
 # Change to an example directory
 os.chdir("../../examples/08_wind_electrolyzer/")
@@ -204,17 +207,12 @@ display(
 *Figure: Interactive OpenMDAO N2 diagram showing the full model structure and variable connections.*
 
 
-
 ## Running the analysis
 
 Once you have the config files defined, you can run the analysis using a simple Python script that inputs the top-level config yaml.
 Here, we will show a script that runs one of the example analyses included in the H2Integrate package.
 
 ```{code-cell} ipython3
-from h2integrate.core.h2integrate_model import H2IntegrateModel
-import os
-
-
 # Change the current working directory
 os.chdir("../../examples/08_wind_electrolyzer/")