Skip to content

Commit

Permalink
loadfns, get_colors, and cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
c-randall committed Sep 13, 2024
1 parent 80044e0 commit 6f0dcf2
Show file tree
Hide file tree
Showing 15 changed files with 101 additions and 319 deletions.
12 changes: 3 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
value: Thanks for taking the time to fill out this bug report!

- type: input
id: version
Expand Down Expand Up @@ -40,11 +39,7 @@ body:
attributes:
label: Steps to Reproduce
description: |
Provide clear steps to reproduce the bug. Ideally, include a code block
that demonstrates the issue. Aim for a minimal, easy-to-understand example
by simplifying or removing unnecessary parts of your code. Only include
code leading up to where the error occurs—for instance, if the error is
thrown on line 30, do not include any lines after that.
Provide clear steps to reproduce the bug. Ideally, include a code block that demonstrates the issue. Aim for a minimal, easy-to-understand example by simplifying or removing unnecessary parts of your code. Only include code leading up to where the error occurs—for instance, if the error is thrown on line 30, do not include any lines after that.
validations:
required: true

Expand All @@ -53,6 +48,5 @@ body:
attributes:
label: Relevant log output
description: |
Copy and paste any relevant log output. Your log will automatically be
formatted into code, so there is no need for backticks.
Copy and paste any relevant log output. Your log will automatically be formatted into code, so there is no need for backticks.
render: shell
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Documentation
description: File a bug report
title: "[docs]: "
labels: ["documentation"]

body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this report!

- type: radio
id: problem-type
attributes:
label: Problem/request type
description: What are you trying to get fixed or added?
options:
- label: typo
- label: example request
- label: broken link
- label: other
validations:
required: true

- type: textarea
id: detailed-explanation
attributes:
label: Detailed explanation
description: |
On what page is the typo or link broken? Include the page url and refer to a specific section when possible. If you are requesting an example, what would you like to see demonstrated? For anything else, be concise, but provide enough detail to make sure the issue/request can be further investigated.
validations:
required: true
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ labels: ["feature"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this form!
value: Thanks for taking the time to fill out this form!

- type: textarea
id: description
Expand All @@ -20,8 +19,9 @@ body:
id: motivation
attributes:
label: Motivation
description: |
How does the feature improve the package? What is the expected outcome?
description: How does the feature improve the package? What is the expected outcome?
validations:
required: true

- type: textarea
id: additional-context
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./images/dark.svg"
<source media="(prefers-color-scheme: dark)" srcset="./images/dark.png"
style="width: 75%; min-width: 250px; max-width: 500px;"/>
<img alt="thevenin logo" src="./images/light.svg"
<img alt="thevenin logo" src="./images/light.png"
style="width: 75%; min-width: 250px; max-width: 500px;"/>
</picture>

Expand All @@ -22,7 +22,7 @@
[pep-l]: https://www.python.org/dev/peps/pep-0008

## Summary
This package is a wrapper for the well-known Thevenin equivalent circuit model. The model is comprised of a single series reistor followed by any number of parallel RC pairs. Figure 1 below illustrates a circuit with 2 RC paris; however, the model can be run with as few as zero, and as many as $N$.
This package is a wrapper for the well-known Thevenin equivalent circuit model. The model is comprised of a single series reistor followed by any number of parallel RC pairs. Figure 1 below illustrates a circuit with 2 RC pairs; however, the model can be run with as few as zero, and as many as $N$.

<p align="center">
<img alt="2RC Thevenin circuit." src="./images/thevenin_circuit.png"
Expand Down Expand Up @@ -98,7 +98,9 @@ sol.plot('capacity_Ah', 'voltage_V')
* If you are new to Python, check out [Spyder IDE](https://www.spyder-ide.org/). Spyder is a powerful interactive development environment (IDE) that can make programming in Python more approachable to new users.

## Contributing
If you'd like to contribute to this package, please look through the existing [issues](). If the bug you've caught or the feature you'd like to add isn't already being worked on, please submit a new issue before getting started. You should also read through the [developer guidelines]().
If you'd like to contribute to this package, please look through the existing [issues](https://github.com/ROVI-org/thevenin/issues). If the bug you've caught or the feature you'd like to add isn't already being worked on, please submit a new issue before getting started. You should also read through the [developer guidelines](https://rovi-org.github.io/thevenin/development).

## Acknowledgements
This work was authored by the National Renewable Energy Laboratory (NREL), operated by Alliance for Sustainable Energy, LLC, for the U.S. Department of Energy (DOE). The views expressed in the repository do not necessarily represent the views of the DOE or the U.S. Government.
This work was authored by the National Renewable Energy Laboratory (NREL), operated by Alliance for Sustainable Energy, LLC, for the U.S. Department of Energy (DOE). The views expressed in the repository do not necessarily represent the views of the DOE or the U.S. Government.

The motivation and funding for this project came from the Rapid Operational Validation Initiative (ROVI) sponsored by the Office of Electricity. The focus of ROVI is "to greatly reduce time required for emerging energy storage technologies to go from lab to market by developing new tools that will accelerate the testing and validation process needed to ensure commercial success." If interested, you can read more about ROVI [here](https://www.energy.gov/oe/rapid-operational-validation-initiative-rovi).
Loading

0 comments on commit 6f0dcf2

Please sign in to comment.