From 704a40875e318fff6c11d3f3481df9be11b6f46c Mon Sep 17 00:00:00 2001
From: Rob Hammond <13874373+RHammond2@users.noreply.github.com>
Date: Fri, 8 Nov 2024 09:32:05 -0800
Subject: [PATCH] Revert "Enhancement: Update issue and PR templates (#35)"

This reverts commit a0cc8175bdc8790702918e4a0e90b9bc93f1657a.
---
 .github/ISSUE_TEMPLATE/bug_report.md          | 110 +++++++++---------
 .github/ISSUE_TEMPLATE/feature_request.md     |  61 ++++++----
 .github/PULL_REQUEST_TEMPLATE.md              |  94 ++++++++-------
 .github/workflows/ci.yml                      |  23 +++-
 README.md                                     |   2 +-
 docs/install.md                               |   2 +-
 environment.yml                               |   2 +-
 greenheart/tools/eco/electrolysis.py          |   2 -
 greenheart/tools/optimization/openmdao.py     |  90 --------------
 pyproject.toml                                |   1 +
 .../test_h2_transport/test_h2_compressor.py   |   2 +-
 11 files changed, 163 insertions(+), 226 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index b10d33a7..ca5ae94a 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -6,73 +6,77 @@ labels: "Type: Bug"
 ---
 
 <!--
+IMPORTANT NOTES
+
 Thank you for taking the time to report a bug. If you aren't certain whether an issue
 is a bug, please first open a Discussion. Before submitting, please reread your
 description to ensure that other readers can reasonably understand the issue
 you're facing and the impact on your workflow or results.
 
-IMPORTANT NOTES
+This form is written in GitHub's Markdown format. For a reference on this type
+of syntax, see GitHub's documentation:
+https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
 
-1. Replace all example text (contained in "<>") or anywhere specifically commenting to replace the
-   text, leaving any guiding HTML comments in place (formatted like this large block so it won't
-   show up in your Bug Report text.)
-2. Use GH flavored markdown: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax,
-   especially for code snippets, which should look like the following:
-   ```python
-   a = 1
-   b = 2
-   print(a + b)
-   ```
-3. Please be as thorough as possible when describing what went wrong, and what was expected from a
-   correct solution. The amount of information required to describe the bug may differ, but more
-   information is always helpful to ensure you receive the help you need.
--->
+This template contains guidance for your submission within the < ! - -, - - > blocks.
+These are comments in HTML syntax and will not appear in the submission.
+Be sure to use the "Preview" feature on GitHub to ensure your submission is formatted as intended.
 
-<!--The title should clearly define the issue succinctly.-->
-# Add meaningful title here
+When including code snippets, please paste the text itself and wrap the code block with
+ticks (see the other character on the tilde ~ key in a US keyboard) to format it as code.
+For example, Python code should be wrapped in ticks like this:
+```python
+def a_func():
+    return 1
 
-<!-- Describe your bug/issue here using as much detail as necessary. -->
+a = 1
+b = a_func()
+print(a + b)
+```
+This is preferred over screen shots since it is searchable and others can copy/paste
+the text to run it.
+-->
 
+# Add meaningful title here
+<!--
+A clear and concise description of the bug including what happened
+and what you expected to happen.
+-->
 
 ## How to reproduce
-
-<!-- Describe how another person with no context can recreate this issue. -->
-
+<!--
+Describe how another person with no context can recreate this issue.
+It is typically very helpful to reduce the problem as much as possible
+and share a minimum working example. See the note above on including
+code as text rather than screenshots.
+-->
 
 ## Relevant output
+<!--
+Include any output, plots, or other means of communication here to add context to the problem.
+ -->
 
-<!-- Include any output, plots, tracebacks, or other means of communication here to add context to
-the problem. All code and full tracebacks should be properly markdown formatted. -->
-
+## GreenHEART version
+<!--
+Share your GreenHEART version and how you installed it. You can print the GreenHEART version from
+a Python REPL or script with these commands:
+```python
+import greenheart
+print(greenheart.__version__)
+```
+ -->
 
 ## System Information
 <!-- Add your information here. -->
-- OS: <macOS 12.4>
-  <!-- e.g. Ubuntu 20.04 or macOS 10.12 -->
-- Python version: <3.10.4>
-  <!-- All OS: `python --version`-->
-- GreenHEART version: <0.1.1>
-  <!--
-  Unix: pip freeze | grep greenheart | awk -F"git@" '/git@/{print $2}' | awk -F"#egg" '/#egg/{print $1}'
-  Windows: `pip list --format freeze | findstr greenheart`
-  -->
-  - <Installed from source using an editable installation with developer tools: `pip install -e .[develop]`>
-  - Commit hash: <commit-hash>
-    <!--
-    Unix: `pip freeze | grep greenheart | awk -F"git@" '/git@/{print $2}' | awk -F"#egg" '/#egg/{print $1}'`
-    Windows: `pip freeze | findstr greenheart`, then copy the full git hash between "git@" and "#egg"
-    -->
-
-### Relevant library versions
-<!--
-Use `pip freeze` to gather the relevant versions, and use the markdown table formatting as
-demonstrated below to replacing all relavant packages and their versions.
--->
-  
-  | Package | Version |
-  | ------- | ------- |
-  | hopp | <3.1.1> |
-  | numpy | <1.26.4> |
-  | Pyomo | <6.8.0> |
-  | scipy | <1.14.1> |
-  | <another-relevant-package> | <version> |
+ - OS: <e.g. Ubuntu 20.04 or macOS 10.12>
+ - Python version: <Result of `python --version`>
+ - Relevant library versions, from the results of `pip freeze`, for example:
+   - FLORIS
+   - HOPP
+   - matplotlib
+   - NREL-PySAM
+   - numpy
+   - numexpr
+   - orbit-nrel
+   - pandas
+   - scipy
+   - shapely
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index d7635a0b..221ab53c 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -6,41 +6,52 @@ labels: 'Type: Enhancement'
 ---
 
 <!--
+IMPORTANT NOTES
+
 Thank you for taking the time to suggest a feature. Before submitting,
 please reread your description to ensure that other readers can reasonably
 understand the motivation and proposed solution.
 
-IMPORTANT NOTES
-
-1. Leave all HTML comments in place (formatted like this large block so it won't show up in
-   your Feature Request text.)
-2. Use GH flavored markdown: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax,
-   especially for code snippets, which should look like the following:
-   ```python
-   a = 1
-   b = 2
-   print(a + b)
-   ```
-3. Please be as thorough as possible when describing what the proposed enhancement or feature should
-   do, including any finer details to guide implementation.
+This form is written in GitHub's Markdown format. For a reference on this type
+of syntax, see GitHub's documentation:
+https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
+This template contains guidance for your submission within the < ! - -, - - > blocks.
+These are comments in HTML syntax and will not appear in the submission.
+Be sure to use the "Preview" feature on GitHub to ensure your submission is formatted as intended.
+
+When including code snippets, please paste the text itself and wrap the code block with
+ticks (see the other character on the tilde ~ key in a US keyboard) to format it as code.
+For example, Python code should be wrapped in ticks like this:
+```python
+def a_func():
+    return 1
+
+a = 1
+b = a_func()
+print(a + b)
+```
+This is preferred over screen shots since it is searchable and others can copy/paste
+the text to run it.
 -->
 
-<!--The title should clearly define the feature request/enhancement succinctly.-->
 # Add meaningful title here
-
-<!-- Describe the desired enhancement. -->
-
+<!--
+High level description of the feature request including motivation and background.
+-->
 
 ## Proposed solution
-
-<!-- Please include pseudocode (markdown-formatted), images, or any other visual aids to communicate the idea. -->
-
+<!--
+Here's an opportunity to prototype a feature. Please include pseudocode, images, or
+any other visual aids to communicate the idea.
+-->
 
 ## Alternatives considered
-
-<!-- Describe workarounds or alternatives even if hacky or incomplete. Sometimes these are the best solution! -->
-
+<!--
+Describe workarounds or alternatives even if hacky or incomplete.
+-->
 
 ## Additional context
-
-<!-- Provide anything else that helps to communicate the idea here. -->
+<!--
+Optional. Provide anything else that helps to communicate the idea here.
+-->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index c9f89c71..dca3531e 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,71 +2,69 @@
 <!--
 IMPORTANT NOTES
 
-1. Use GH flavored markdown when writing your description:
-   https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
-
-2. If all boxes in the PR Checklist cannot be checked, this PR should be marked as a draft.
-
-3. DO NOT DELTE ANYTHING FROM THIS TEMPLATE. If a section does not apply to you, simply write
-   "N/A" in the description.
-
-4. Code snippets to highlight new, modified, or problematic functionality are highly encouraged,
-   though not required. Be sure to use proper code higlighting as demonstrated below.
-
-   ```python
-    def a_func():
-        return 1
-
-    a = 1
-    b = a_func()
-    print(a + b)
-    ```
+Is this pull request ready to be merged?
+- Do the existing tests pass and new tests added for new code?
+- Is all development in a state where you are proud to share it with others and
+  willing to ask other people to take the time to review it?
+- Is it documented in such a way that a review can reasonably understand what you've
+  done and why you've done it? Can other users understand how to use your changes?
+If not but opening the pull request will facilitate development, make it a "draft" pull request
+
+This form is written in GitHub's Markdown format. For a reference on this type
+of syntax, see GitHub's documentation:
+https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
+
+This template contains guidance for your submission within the < ! - -, - - > blocks.
+These are comments in HTML syntax and will not appear in the submission.
+Be sure to use the "Preview" feature on GitHub to ensure your submission is formatted as intended.
+
+When including code snippets, please paste the text itself and wrap the code block with
+ticks (see the other character on the tilde ~ key in a US keyboard) to format it as code.
+For example, Python code should be wrapped in ticks like this:
+```python
+def a_func():
+    return 1
+
+a = 1
+b = a_func()
+print(a + b)
+```
+This is preferred over screen shots since it is searchable and others can copy/paste
+the text to run it.
 -->
 
-<!--The title should clearly define your contribution succinctly.-->
-# Add meaningful title here
-
-<!-- Describe your feature here. Please include any code snippets or examples in this section. -->
-
-
-## PR Checklist
 
-<!--Tick these boxes if they are complete, or format them as "[x]" for the markdown to render. -->
-- [ ] `CHANGELOG.md` has been updated to describe the changes made in this PR
-- [ ] Documentation
-  - [ ] Docstrings are up-to-date
-  - [ ] Related `docs/` files are up-to-date, or added when necessary
-  - [ ] Documentation has been rebuilt successfully
-  - [ ] Examples have been updated
-- [ ] Tests pass (If not, and this is expected, please elaborate in the tests section)
-- [ ] PR description thoroughly describes the new feature, bug fix, etc.
-
-## Related issues
-
-<!--If one exists, link to a related GitHub Issue.-->
+# Add meaningful title here
+<!--
+Be sure to title your pull request so that readers can scan through the list of PR's and understand
+what this one involves. It should be a few well selected words to get the point across. If you have
+a hard time choosing a brief title, consider splitting the pull request into multiple pull requests.
+Keep in mind that the title will be automatically included in the release notes.
+-->
+Describe your feature here.
 
+## Related issue
+<!--
+If one exists, link to a related GitHub Issue.
+-->
 
 ## Impacted areas of the software
-
 <!--
-Replace the below example with any added or modified files, and briefly describe what has been changed or added, and why.
+List any modules or other areas which should be impacted by this pull request. This helps to
+determine the verification tests.
 -->
-- `path/to/file.extension`
-  - `method1`: What and why something was changed in one sentence or less.
 
 ## Additional supporting information
-
-<!--Add any other context about the problem here.-->
-
+<!--
+Add any other context about the problem here.
+-->
 
 ## Test results, if applicable
-
 <!--
 Add the results from unit tests and regression tests here along with justification for any
 failing test cases.
 -->
 
-
 <!--
 __ For NREL use __
 Release checklist:
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 690b99b9..b778309b 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -6,29 +6,44 @@ jobs:
   build:
 
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -el {0}
     strategy:
       matrix:
         python-version: ["3.9", "3.10", "3.11"]
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+      - uses: actions/checkout@v4
+      - name: Set up Miniconda Python ${{ matrix.python-version }}
+        uses: conda-incubator/setup-miniconda@v3
         with:
+          auto-update-conda: true
           python-version: ${{ matrix.python-version }}
+          channels: conda-forge
+          activate-environment: greenheart-test-${{ matrix.python-version }}
       - name: Install dependencies
         env:
           SKLEARN_ALLOW_DEPRECATED_SKLEARN_PACKAGE_INSTALL: True
         run: |
           sudo apt-get update && sudo apt-get install -y libglpk-dev glpk-utils coinor-cbc
           python -m pip install --upgrade pip
-          pip install ProFAST@git+https://github.com/NREL/ProFAST.git
+          pip install electrolyzer@git+https://github.com/jaredthomas68/electrolyzer.git@smoothing
           pip install ".[develop]"
       - name: Create env file
         run: |
           touch .env
       #     echo NREL_API_KEY=${{ secrets.NREL_API_KEY }} >> .env
       #     cat .env
+      - name: Save environment build details
+        run: |
+          mkdir ~/artifacts
+          conda env export --file ~/artifacts/environment.yml
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.python-version }}-environment
+          path: ~/artifacts/environment.yml
       - name: Run tests
         run: |
           PYTHONPATH=. pytest tests
diff --git a/README.md b/README.md
index 2e0d5c82..3aaf487f 100644
--- a/README.md
+++ b/README.md
@@ -124,7 +124,7 @@ pip install -e ".[all]"
 
     ```bash
     conda install -y -c conda-forge glpk
-    pip install ProFAST@git+https://github.com/NREL/ProFAST.git
+    pip install electrolyzer@git+https://github.com/jaredthomas68/electrolyzer.git@smoothing
     ```
 
     Note: Unix users should install Cbc via:
diff --git a/docs/install.md b/docs/install.md
index b61dc071..4c7eaa0f 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -108,7 +108,7 @@ pip install -e ".[all]"
 
     ```bash
     conda install -y -c conda-forge glpk
-    pip install ProFAST@git+https://github.com/NREL/ProFAST.git
+    pip install electrolyzer@git+https://github.com/jaredthomas68/electrolyzer.git@smoothing
     ```
 
     ````{note}
diff --git a/environment.yml b/environment.yml
index 46effdcf..592d208f 100644
--- a/environment.yml
+++ b/environment.yml
@@ -7,5 +7,5 @@ dependencies:
   - glpk
   - pip
   - pip:
-    - ProFAST@git+https://github.com/NREL/ProFAST.git
+    - electrolyzer@git+https://github.com/jaredthomas68/electrolyzer.git@smoothing
     - "."
diff --git a/greenheart/tools/eco/electrolysis.py b/greenheart/tools/eco/electrolysis.py
index 31a21b18..de06d96d 100644
--- a/greenheart/tools/eco/electrolysis.py
+++ b/greenheart/tools/eco/electrolysis.py
@@ -31,8 +31,6 @@
 
 from greenheart.simulation.technologies.hydrogen.electrolysis.PEM_BOP.PEM_BOP import pem_bop
 
-# from electrolyzer import run_electrolyzer
-
 
 def run_electrolyzer_physics(
     hopp_results,
diff --git a/greenheart/tools/optimization/openmdao.py b/greenheart/tools/optimization/openmdao.py
index d3146a92..405c9624 100644
--- a/greenheart/tools/optimization/openmdao.py
+++ b/greenheart/tools/optimization/openmdao.py
@@ -1,9 +1,6 @@
 import numpy as np
 import openmdao.api as om
 
-import electrolyzer.inputs.validation as val
-from electrolyzer import run_lcoh
-
 from shapely.geometry import Polygon, Point
 from hopp.simulation import HoppInterface
 from greenheart.simulation.greenheart_simulation import GreenHeartSimulationConfig, run_simulation
@@ -305,90 +302,3 @@ def compute(self, inputs, outputs):
 
     def setup_partials(self):
         self.declare_partials('*', '*', method='fd', form='forward')
-
-class ElectrolyzerComponent(om.ExplicitComponent):
-    """
-    This is an OpenMDAO wrapper to the generic electrolyzer model.
-
-    It makes some assumptions about the number of electrolyzers, stack size, and
-    how to distribute electricity across the different electrolyzers. These
-    could be later made into modeling options to allow for more user configuration.
-    """
-    def initialize(self):
-        self.options.declare("h2_modeling_options")
-        self.options.declare("h2_opt_options")
-        self.options.declare("modeling_options")
-        self.options.declare("design_variables", 
-                             # ["electrolyzer_rating_kw"], 
-                             types=list, 
-                             desc="List of design variables that should be included",
-                             default=[],
-                             recordable=False)
-
-    def setup(self):
-        self.add_input("power_signal", val=np.zeros(8760), units="W")
-        self.add_input("lcoe_real", units="USD/kW/h")
-
-        if "electrolyzer_rating_kw" in self.options["design_variables"]:
-            self.add_input("electrolyzer_rating_kw", val=15000, units="kW")
-
-        if self.options["h2_opt_options"]["control"]["system_rating_MW"]["flag"] \
-            or self.options["modeling_options"]["rating_equals_turbine_rating"]:
-            self.add_input("system_rating_MW", units="MW", val=self.options["h2_modeling_options"]["electrolyzer"]["control"]["system_rating_MW"])
-        self.add_output("h2_produced", units="kg")
-        self.add_output("max_curr_density", units="A/cm**2")
-        self.add_output("electrolyzer_capex", units="USD")
-        self.add_output("electrolyzer_opex", units="USD")
-        self.add_output("lcoh", units="USD/kg") 
-        self.add_output("h2_produced_hourly", units="kg", val=np.zeros(8760)) 
-        self.add_output("power_kW_curtailed", units="kW", val=np.zeros(8760)) 
-        self.add_output("power_kW_avail", units="kW", val=np.zeros(8760)) 
-        # self.add_output("deg_state", units="V", val=np.zeros(6)) # TODO we need a way to size this dynamically
-
-    def compute(self, inputs, outputs):
-        # Set electrolyzer parameters from model inputs
-        power_signal = inputs["power_signal"]
-        lcoe_real = inputs["lcoe_real"][0]
-        
-        if "electrolyzer_rating_kw" in inputs:
-            self.options["h2_modeling_options"]["electrolyzer"]["control"]["system_rating_MW"] = inputs["electrolyzer_rating_kw"][0]*1E-3
-
-        elif self.options["h2_opt_options"]["control"]["system_rating_MW"]["flag"] \
-            or self.options["modeling_options"]["rating_equals_turbine_rating"]:
-            self.options["h2_modeling_options"]["electrolyzer"]["control"]["system_rating_MW"] = inputs["system_rating_MW"][0]
-
-        elif "electrolyzer_rating_MW" in self.options["modeling_options"]["overridden_values"]:
-            electrolyzer_rating_MW = self.options["modeling_options"]["overridden_values"]["electrolyzer_rating_MW"]
-            self.options["h2_modeling_options"]["electrolyzer"]["control"]["system_rating_MW"] = electrolyzer_rating_MW
-
-        h2_prod, max_curr_density, lcoh, lcoh_dict, lcoh_options_dict,  = run_lcoh(
-            self.options["h2_modeling_options"],
-            power_signal,
-            lcoe_real,
-            optimize=True
-        )
-
-        lt = lcoh_dict["LCOH Breakdown"]["Life Totals [$]"]
-        capex = lt["CapEx"]
-        opex = lt["OM"]
-
-        # msg = (
-        #     f"\n====== Electrolyzer ======\n"
-        #     f"  - h2 produced (kg): {h2_prod}\n"
-        #     f"  - max current density (A/cm^2): {max_curr_density}\n"
-        #     f"  - LCOH ($/kg): {lcoh}\n"
-        # )
-
-        # logger.info(msg)
-        outputs["h2_produced"] = h2_prod
-        outputs["max_curr_density"] = max_curr_density
-        outputs["electrolyzer_capex"] = capex
-        outputs["electrolyzer_opex"] = opex
-        outputs["lcoh"] = lcoh
-        outputs["h2_produced_hourly"] = lcoh_options_dict["kg_produced"]
-        outputs["power_kW_curtailed"] = lcoh_options_dict["power_kW_curtailed"]
-        outputs["power_kW_avail"] = lcoh_options_dict["power_kW_avail"]
-        # outputs["deg_state"] = lcoh_options_dict["deg_state"] # TODO we need a way to size this dynamically
-
-    def setup_partials(self):
-        self.declare_partials('lcoh', '*', method='fd', form='forward')
diff --git a/pyproject.toml b/pyproject.toml
index 4fd313af..b15c7944 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -52,6 +52,7 @@ dependencies = [
     "HOPP>=3.0",
     "orbit-nrel>=1.1",
     "openmdao[all]",
+    "ProFAST",
 ]
 keywords = [
     "python3",
diff --git a/tests/greenheart/test_hydrogen/test_h2_transport/test_h2_compressor.py b/tests/greenheart/test_hydrogen/test_h2_transport/test_h2_compressor.py
index dbf423e3..f1696301 100644
--- a/tests/greenheart/test_hydrogen/test_h2_transport/test_h2_compressor.py
+++ b/tests/greenheart/test_hydrogen/test_h2_transport/test_h2_compressor.py
@@ -43,7 +43,7 @@ def test_system_power_report(self):
         comp = Compressor(p_outlet, flow_rate_kg_per_day, p_inlet=p_inlet, n_compressors=n_compressors, sizing_safety_factor=sizing_safety_factor)
         comp.compressor_power()
         _motor_rating, total_system_power = comp.compressor_system_power()
-        assert total_system_power == 3627.3907562149357
+        assert total_system_power == approx(3627.3907562149357)
 
     def test_max_flow_rate_per_compressor(self):
         p_inlet = 20 # bar