Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: I just have a question...
url: https://github.com/NREL/thevenin/discussions
url: https://github.com/NatLabRockies/thevenin/discussions
about: Join our discussion instead. Search for existing questions, or ask a new one!
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Please include a summary of the change and which issue is fixed. Please also inc
Fixes # (issue)

## Type of change
Please add a line in the relevant section of [CHANGELOG.md](https://github.com/NREL/thevenin/blob/main/CHANGELOG.md) to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.
Please add a line in the relevant section of [CHANGELOG.md](https://github.com/NatLabRockies/thevenin/blob/main/CHANGELOG.md) to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

- [ ] New feature (non-breaking change which adds functionality)
- [ ] Optimization (back-end change that improves speed/readability/etc.)
Expand Down
53 changes: 27 additions & 26 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,52 @@
# thevenin Changelog

## [Unreleased](https://github.com/NREL/thevenin)
## [Unreleased](https://github.com/NatLabRockies/thevenin)

### New Features
- New functions to list, load, print, and download `.yaml` templates ([#26](https://github.com/NREL/thevenin/pull/26))
- Drop support for Python 3.9 and add support for 3.14 in tests/release ([#23](https://github.com/NREL/thevenin/pull/23))
- Add version warning banner to docs for dev and older releases ([#22](https://github.com/NREL/thevenin/pull/22))
- Add `to_simulation` and `to_prediction` methods to switch between interfaces ([#20](https://github.com/NREL/thevenin/pull/20))
- Allow `TransientState` as an input option to `sim.pre()` ([#14](https://github.com/NREL/thevenin/pull/14))
- New functions to list, load, print, and download `.yaml` templates ([#26](https://github.com/NatLabRockies/thevenin/pull/26))
- Drop support for Python 3.9 and add support for 3.14 in tests/release ([#23](https://github.com/NatLabRockies/thevenin/pull/23))
- Add version warning banner to docs for dev and older releases ([#22](https://github.com/NatLabRockies/thevenin/pull/22))
- Add `to_simulation` and `to_prediction` methods to switch between interfaces ([#20](https://github.com/NatLabRockies/thevenin/pull/20))
- Allow `TransientState` as an input option to `sim.pre()` ([#14](https://github.com/NatLabRockies/thevenin/pull/14))

### Optimizations
- Change `tspan` constructor in experiments to allow floats, but not `(tmax, Nt)` ([#29](https://github.com/NREL/thevenin/pull/29))
- Change `tspan` constructor in experiments to allow floats, but not `(tmax, Nt)` ([#29](https://github.com/NatLabRockies/thevenin/pull/29))

### Bug Fixes
- Update patching policy for releases, fix warnings in tests ([#25](https://github.com/NREL/thevenin/pull/25))
- Fix links to Read the Docs `Development` page in `README` file ([#21](https://github.com/NREL/thevenin/pull/21))
- Use `for` loops in `Solution` post-processing if arrays are incompatible ([#18](https://github.com/NREL/thevenin/pull/18))
- Update patching policy for releases, fix warnings in tests ([#25](https://github.com/NatLabRockies/thevenin/pull/25))
- Fix links to Read the Docs `Development` page in `README` file ([#21](https://github.com/NatLabRockies/thevenin/pull/21))
- Use `for` loops in `Solution` post-processing if arrays are incompatible ([#18](https://github.com/NatLabRockies/thevenin/pull/18))

### Breaking Changes
- There is no longer a `linspace` option from `tspan: tuple[float, int]` construction ([#29](https://github.com/NREL/thevenin/pull/29))
- `initial_state` was renamed to `state0` in `sim.pre()` ([#14](https://github.com/NREL/thevenin/pull/14))
- There is no longer a `linspace` option from `tspan: tuple[float, int]` construction ([#29](https://github.com/NatLabRockies/thevenin/pull/29))
- `initial_state` was renamed to `state0` in `sim.pre()` ([#14](https://github.com/NatLabRockies/thevenin/pull/14))

### Chores
- Allow single backticks for sphinx inline code (`default_role = 'literal'`) ([#28](https://github.com/NREL/thevenin/pull/28))
- Rebrand NREL to NLR, and include name change for Alliance as well ([#27](https://github.com/NREL/thevenin/pull/27))
- Make GitHub hyperlinks reference new org name `NREL` -> `NatLabRockies` ([#30](https://github.com/NatLabRockies/thevenin/pull/30))
- Allow single backticks for sphinx inline code (`default_role = 'literal'`) ([#28](https://github.com/NatLabRockies/thevenin/pull/28))
- Rebrand NREL to NLR, and include name change for Alliance as well ([#27](https://github.com/NatLabRockies/thevenin/pull/27))

## [v0.2.0](https://github.com/NREL/thevenin/tree/v0.2.0)
## [v0.2.0](https://github.com/NatLabRockies/thevenin/tree/v0.2.0)

### New Features
- Allow the `CycleSolution` to append more solutions after it has been initialized ([#9](https://github.com/NREL/thevenin/pull/9))
- New `Prediction` and `TransientState` classes for an improved interface to Kalman filters ([#8](https://github.com/NREL/thevenin/pull/8))
- Added hysteresis (`hsyt`) to the model, controlled with `gamma` and `M_hyst` parameters ([#7](https://github.com/NREL/thevenin/pull/7))
- Allow the `CycleSolution` to append more solutions after it has been initialized ([#9](https://github.com/NatLabRockies/thevenin/pull/9))
- New `Prediction` and `TransientState` classes for an improved interface to Kalman filters ([#8](https://github.com/NatLabRockies/thevenin/pull/8))
- Added hysteresis (`hsyt`) to the model, controlled with `gamma` and `M_hyst` parameters ([#7](https://github.com/NatLabRockies/thevenin/pull/7))

### Optimizations
- Make `num_RC_pairs` read-only so now `pre` only needs to be called to reset the state ([#13](https://github.com/NREL/thevenin/pull/13))
- Use `np.testing` where possible in tests for more informative fail statements ([#10](https://github.com/NREL/thevenin/pull/10))
- Pre-initialize `CycleSolution` arrays rather than appending lists, much faster ([#7](https://github.com/NREL/thevenin/pull/7))
- Add `ExitHandler` for single `plt.show` registrations, replaces `show_plot` option in `Solutions` ([#7](https://github.com/NREL/thevenin/pull/7))
- Make `num_RC_pairs` read-only so now `pre` only needs to be called to reset the state ([#13](https://github.com/NatLabRockies/thevenin/pull/13))
- Use `np.testing` where possible in tests for more informative fail statements ([#10](https://github.com/NatLabRockies/thevenin/pull/10))
- Pre-initialize `CycleSolution` arrays rather than appending lists, much faster ([#7](https://github.com/NatLabRockies/thevenin/pull/7))
- Add `ExitHandler` for single `plt.show` registrations, replaces `show_plot` option in `Solutions` ([#7](https://github.com/NatLabRockies/thevenin/pull/7))

### Bug Fixes
- Change to using `_T_ref` to scale the temperature equation since `T_inf` can be modified ([#12](https://github.com/NREL/thevenin/pull/12))
- Hyseteresis voltage was missing in `Qgen` heat transfer terms, now incorporated ([#11](https://github.com/NREL/thevenin/pull/11))
- Change to using `_T_ref` to scale the temperature equation since `T_inf` can be modified ([#12](https://github.com/NatLabRockies/thevenin/pull/12))
- Hyseteresis voltage was missing in `Qgen` heat transfer terms, now incorporated ([#11](https://github.com/NatLabRockies/thevenin/pull/11))

### Breaking Changes
- New hysteresis option requires updating old `params` inputs to include `gamma` and `M_hyst` ([#7](https://github.com/NREL/thevenin/pull/7))
- New hysteresis option requires updating old `params` inputs to include `gamma` and `M_hyst` ([#7](https://github.com/NatLabRockies/thevenin/pull/7))

## [v0.1.0](https://github.com/NREL/thevenin/tree/v0.1.0)
## [v0.1.0](https://github.com/NatLabRockies/thevenin/tree/v0.1.0)
This is the first official release of `thevenin`. Main features/capabilities are listed below.

### Features
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- <img alt='Logo' style='width: 75%; min-width: 250px; max-width: 500px;'
src='https://github.com/NREL/thevenin/blob/main/images/dark.png?raw=true#gh-dark-mode-only'/>
src='https://github.com/NatLabRockies/thevenin/blob/main/images/dark.png?raw=true#gh-dark-mode-only'/>
<img alt='Logo' style='width: 75%; min-width: 250px; max-width: 500px;'
src='https://github.com/NREL/thevenin/blob/main/images/light.png?raw=true#gh-light-mode-only'/> -->
src='https://github.com/NatLabRockies/thevenin/blob/main/images/light.png?raw=true#gh-light-mode-only'/> -->

# thevenin

Expand All @@ -10,11 +10,11 @@
![coverage][cov-b] &nbsp;
[![pep8][pep-b]][pep-l]

[ci-b]: https://github.com/NREL/thevenin/actions/workflows/ci.yml/badge.svg
[ci-l]: https://github.com/NREL/thevenin/actions/workflows/ci.yml
[ci-b]: https://github.com/NatLabRockies/thevenin/actions/workflows/ci.yml/badge.svg
[ci-l]: https://github.com/NatLabRockies/thevenin/actions/workflows/ci.yml

[test-b]: https://github.com/NREL/thevenin/blob/main/images/tests.svg?raw=true
[cov-b]: https://github.com/NREL/thevenin/blob/main/images/coverage.svg?raw=true
[test-b]: https://github.com/NatLabRockies/thevenin/blob/main/images/tests.svg?raw=true
[cov-b]: https://github.com/NatLabRockies/thevenin/blob/main/images/coverage.svg?raw=true

[pep-b]: https://img.shields.io/badge/code%20style-pep8-orange.svg
[pep-l]: https://www.python.org/dev/peps/pep-0008
Expand All @@ -24,7 +24,7 @@ This package is a wrapper for the well-known Thevenin equivalent circuit model.

<p align="center">
<img alt="2RC Thevenin circuit." style="width: 75%; min-width: 250px; max-width: 500px;"
src="https://github.com/NREL/thevenin/blob/main/images/example_circuit.png?raw=true"/>
src="https://github.com/NatLabRockies/thevenin/blob/main/images/example_circuit.png?raw=true"/>
</br>
Figure 1: 2RC Thevenin circuit.
</p>
Expand Down Expand Up @@ -72,7 +72,7 @@ If you prefer using the `conda` package manager, you can install `thevenin` from
conda install -c conda-forge thevenin
```

If you run into issues with installation due to the [scikit-sundae](https://github.com/NREL/scikit-sundae) dependency, please submit an issue [here](https://github.com/NREL/scikit-sundae/issues). We also manage this solver package, but distribute it separately since it is not developed in pure Python.
If you run into issues with installation due to the [scikit-sundae](https://github.com/NatLabRockies/scikit-sundae) dependency, please submit an issue [here](https://github.com/NatLabRockies/scikit-sundae/issues). We also manage this solver package, but distribute it separately since it is not developed in pure Python.

For those interested in setting up a developer and/or editable version of this software, please see the directions available in the "Development" section of our [documentation](https://thevenin.readthedocs.io/latest/development).

Expand All @@ -99,15 +99,15 @@ soln.plot('time_h', 'voltage_V')
## Citing this Work
This work was authored by researchers at the National Laboratory of the Rockies (NLR). If you use this package in your work, please include the following citation:

> Randall, Corey R. "thevenin: Equivalent circuit models in Python [SWR-24-132]." Computer software, Nov. 2024. url: [github.com/NREL/thevenin](https://github.com/NREL/thevenin). doi: [10.11578/dc.20241125.2](https://doi.org/10.11578/dc.20241125.2).
> Randall, Corey R. "thevenin: Equivalent circuit models in Python [SWR-24-132]." Computer software, Nov. 2024. url: [github.com/NatLabRockies/thevenin](https://github.com/NatLabRockies/thevenin). doi: [10.11578/dc.20241125.2](https://doi.org/10.11578/dc.20241125.2).

For convenience, we also provide the following for your BibTex:

```
@misc{randall2024thevenin,
author = {Randall, Corey R.},
title = {{thevenin: Equivalent circuit models in Python [SWR-24-132]}},
url = {github.com/NREL/thevenin},
url = {github.com/NatLabRockies/thevenin},
month = {Nov.},
year = {2024},
doi = {10.11578/dc.20241125.2},
Expand All @@ -118,7 +118,7 @@ For convenience, we also provide the following for your BibTex:
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).

## Contributing
If you'd like to contribute to this package, please look through the existing [issues](https://github.com/NREL/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://thevenin.readthedocs.io/latest/development).
If you'd like to contribute to this package, please look through the existing [issues](https://github.com/NatLabRockies/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://thevenin.readthedocs.io/latest/development).

## Disclaimer
This work was authored by the National Laboratory of the Rockies (NLR), operated by Alliance for Energy Innovation, 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.
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
'icon_links': [
{
'name': 'GitHub',
'url': 'https://github.com/NREL/thevenin',
'url': 'https://github.com/NatLabRockies/thevenin',
'icon': 'fa-brands fa-github',
},
{
Expand Down
Loading