Skip to content

Commit

Permalink
Feature/profast fin model (#355)
Browse files Browse the repository at this point in the history
* add lcoe calculations to the custom financial model using profast

* fix logging error

* fix bug where the presence of skip_financial caused the skip, rather than the value

* adjust battery financials to use discharged energy instead of annual energy for levelized costs

* adjust lcoe calculations so battery is based on discharge and all other are based on aep

* update for using name= in calls to custom fin model

* simplify battery heuristic gen sum

* add interface to profast via the custom financial model financial parameters

* add ProFAST to ci.yaml

* make all tests using the custom financial model use the DEFAULT_FIN_CONFIG

* fix typos

* add profast to docs

* add profast to docs build

* try to fix doc build

* remove profast from .readthedocs and add it to dependencies

* remove profast installation instructions and just have it in .toml

* attempt update docs build to include profast

* remove quotes from text file

* re-add profast to installation ci and readme

* fix financial model instantiation logic for wind

* fix typos in tests

* Debugging ppa CI

* Loosened hybrid wave test tol

* Loosened hybrid wave test tol

* insert financial model dict instead of object in config

* make local copy of fin config before removing revenue section in test_custom_financial

* reset default ppa_price_input to None

* add artifact generation and upgrade actions versions

* fix artifact naming conflict

* use python version for naming

* switch to conda build and export

* correct file output and remove pytest python flag

* remove unsaved deleted line

* enable anaconda/bash in CI

* switch to profast from pypi

* remove requirements.txt installation for docs

* remove comment after verification from benjaminkee

* remove unused imports

* update allowed financial model type to include str and FinancialModelType

* update financial model type dec for battery

* fix duplicate import

* update FinancialParameters doc string

* update revenue doc strings

* remove commented code

---------

Co-authored-by: RHammond2 <[email protected]>
Co-authored-by: John Jasa <[email protected]>
  • Loading branch information
3 people authored Nov 8, 2024
1 parent 84db768 commit 9b856a8
Show file tree
Hide file tree
Showing 32 changed files with 801 additions and 528 deletions.
164 changes: 82 additions & 82 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,82 +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
---
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
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +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.
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.
114 changes: 57 additions & 57 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,57 +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.
-->
---
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.
-->
Loading

0 comments on commit 9b856a8

Please sign in to comment.