Skip to content

Commit

Permalink
Merge pull request #257 from NREL/develop
Browse files Browse the repository at this point in the history
HOPP v2.1.0
  • Loading branch information
camirmas committed Nov 27, 2023
2 parents 0ff143a + b8dd4a8 commit 43e2186
Show file tree
Hide file tree
Showing 41 changed files with 1,080 additions and 554 deletions.
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
name: Bug report
about: Report a bug to help us improve
title: 'Bug report'
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.
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.
-->

# 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.
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.
-->

## HOPP version
<!--
Share your HOPP version and how you installed it. You can print the HOPP version from
a Python REPL or script with these commands:
```python
import hopp
print(hopp.__version__)
```
-->

## System Information
<!-- Add your information here. -->
- OS: <e.g. Ubuntu 20.04 or macOS 10.12>
- Python version: <Result of `python --version`>
- Library versions
- Results of `pip freeze`, for example
- FLORIS
- matplotlib
- NREL-PySAM
- numpy
- numexpr
- orbit-nrel
- pandas
- scipy
- shapely
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Usage question
url: https://github.com/NREL/hopp/discussions
about: Have any questions about using HOPP? Post in Discussions to engage with the NREL team and HOPP community.
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
name: Feature request
about: Suggest an idea for this project
title: 'Feature request'
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.
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.
-->

# Add meaningful title here
<!--
High level description of the feature request including motivation and background.
-->

## Proposed solution
<!--
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.
-->

## Additional context
<!--
Optional. Provide anything else that helps to communicate the idea here.
-->
76 changes: 76 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@

<!--
IMPORTANT NOTES
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.
-->


# 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
<!--
List any modules or other areas which should be impacted by this pull request. This helps to
determine the verification tests.
-->

## Additional supporting information
<!--
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:
- Update the version in
- [ ] README.md
- [ ] hopp/VERSION
- [ ] Verify docs builds correctly
- [ ] Create a tag in the NREL/HOPP repository
-->
21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,6 @@ solar and storage.
pip install HOPP
```

or as a conda package:

```
conda install hopp -c nrel -c conda-forge -c sunpower
```

NOTE: If you install from conda you will need to install `global-land-mask` from PyPi:

```
pip install global-land-mask
```

## Installing from Source
1. Using Git, navigate to a local target directory and clone repository:
```
Expand All @@ -48,14 +36,19 @@ solar and storage.

4. Install dependencies:
```
conda install -c conda-forge coin-or-cbc -y
conda install -c conda-forge coin-or-cbc=2.10.8 -y
conda install -c conda-forge glpk -y
pip install -r requirements.txt
pip install -r requirements-dev.txt
```

Note if you are on Windows, you will have to manually install Cbc: https://github.com/coin-or/Cbc

If you also want development dependencies for running tests and building docs:

```
pip install -r requirements-dev.txt
```

5. Install HOPP:
```
pip install -e .
Expand Down
20 changes: 10 additions & 10 deletions examples/01-wind-solar.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
"/Users/cirmas/workspace/HOPP/examples/workshop/log/hybrid_systems_2023-10-23T12.26.42.533329.log\n"
"/Users/cirmas/workspace/HOPP/examples/log/hybrid_systems_2023-11-22T11.22.32.144293.log\n"
]
}
],
Expand Down Expand Up @@ -92,12 +92,12 @@
"Wind Installed Cost: 72700000.0\n",
"Solar Installed Cost: 48000000.0\n",
"Hybrid Installed Cost: 120700000.0\n",
"Wind NPV: -58492882.36461778\n",
"Solar NPV: -35042037.04939877\n",
"Hybrid NPV: -95120916.57322481\n",
"{\"pv\": 104053614.17593749, \"wind\": 162478037.0463255, \"hybrid\": 254922552.1307209}\n",
"{\"pv\": 23.75653291688071, \"wind\": 37.09544224801952, \"hybrid\": 30.425987582450112}\n",
"{\"pv\": -35042037.04939877, \"wind\": -58492882.36461778, \"hybrid\": -95120916.57322481}\n"
"Wind NPV: -47401363.61809909\n",
"Solar NPV: -33636480.232181095\n",
"Hybrid NPV: -83204102.48278144\n",
"{\"pv\": 104289820.46059448, \"wind\": 156936144.3525474, \"hybrid\": 250449987.43150324}\n",
"{\"pv\": 30.95359968008512, \"wind\": 35.830169943503975, \"hybrid\": 33.70992200288708}\n",
"{\"pv\": -33636480.232181095, \"wind\": -47401363.61809909, \"hybrid\": -83204102.48278144}\n"
]
}
],
Expand Down Expand Up @@ -131,9 +131,9 @@
"hash": "c4181dcdfcea4d6481020f2ce48a9cbe5cdfeb7af5e211e5dfd3ac596bfed8bd"
},
"kernelspec": {
"display_name": "hopp-dev-refactor",
"display_name": "hopp",
"language": "python",
"name": "python3"
"name": "hopp"
},
"language_info": {
"codemirror_mode": {
Expand All @@ -145,7 +145,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.17"
"version": "3.8.18"
}
},
"nbformat": 4,
Expand Down
22 changes: 11 additions & 11 deletions examples/02-wind-solar-api.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"name": "stdout",
"output_type": "stream",
"text": [
"/Users/cirmas/workspace/HOPP/examples/workshop/log/hybrid_systems_2023-10-23T13.52.48.948995.log\n"
"/Users/cirmas/workspace/HOPP/examples/log/hybrid_systems_2023-11-22T11.23.26.584785.log\n"
]
}
],
Expand Down Expand Up @@ -138,12 +138,12 @@
"Wind Installed Cost: 72700000.0\n",
"Solar Installed Cost: 48000000.0\n",
"Hybrid Installed Cost: 120700000.0\n",
"Wind NPV: -47742400.774270594\n",
"Solar NPV: -26412928.585828584\n",
"Hybrid NPV: -76621678.51184756\n",
"{\"pv\": 104053614.17593749, \"wind\": 162478037.0463255, \"hybrid\": 254922552.1307209}\n",
"{\"pv\": 23.75653291688071, \"wind\": 37.09544224801952, \"hybrid\": 30.425987582450112}\n",
"{\"pv\": -26412928.585828584, \"wind\": -47742400.774270594, \"hybrid\": -76621678.51184756}\n"
"Wind NPV: -37054112.94902411\n",
"Solar NPV: -24986062.58280176\n",
"Hybrid NPV: -65015880.48273513\n",
"{\"pv\": 104289820.46059448, \"wind\": 156936144.3525474, \"hybrid\": 250449987.43150324}\n",
"{\"pv\": 30.95359968008512, \"wind\": 35.830169943503975, \"hybrid\": 33.70992200288708}\n",
"{\"pv\": -24986062.58280176, \"wind\": -37054112.94902411, \"hybrid\": -65015880.48273513}\n"
]
}
],
Expand Down Expand Up @@ -176,9 +176,9 @@
"hash": "c4181dcdfcea4d6481020f2ce48a9cbe5cdfeb7af5e211e5dfd3ac596bfed8bd"
},
"kernelspec": {
"display_name": "hopp-dev-refactor",
"display_name": "hopp",
"language": "python",
"name": "python3"
"name": "hopp"
},
"language_info": {
"codemirror_mode": {
Expand All @@ -190,9 +190,9 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.17"
"version": "3.8.18"
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
26 changes: 13 additions & 13 deletions examples/03-wind-solar-battery.ipynb

Large diffs are not rendered by default.

23 changes: 11 additions & 12 deletions examples/04-load-following-battery.ipynb

Large diffs are not rendered by default.

0 comments on commit 43e2186

Please sign in to comment.