Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom event example #105

Merged
merged 5 commits into from
Oct 11, 2023
Merged

Custom event example #105

merged 5 commits into from
Oct 11, 2023

Conversation

kjjarvis
Copy link
Contributor

@kjjarvis kjjarvis commented Oct 6, 2023

Adding example of creating new events in notebook 04. New Models

@kjjarvis kjjarvis requested a review from teubert October 6, 2023 16:42
@github-actions
Copy link

github-actions bot commented Oct 6, 2023

Thank you for opening this PR. Each PR into dev requires a code review. For the code review, look at the following:

  • Reviewer (someone other than author) should look for bugs, efficiency, readability, testing, and coverage in examples (if relevant).
  • Ensure that each PR adding a new feature should include a test verifying that feature.
  • All errors from static analysis must be resolved.
  • Review the test coverage reports (if there is a change) - will be added as comment on PR if there is a change
  • Review the software benchmarking results (if there is a change) - will be added as comment on PR
  • Any added dependencies are included in requirements.txt, setup.py, and dev_guide.rst (this document)
  • All warnings from static analysis must be reviewed and resolved - if deemed appropriate.

Copy link
Contributor

@teubert teubert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. A few small suggestions

examples/04_New Models.ipynb Outdated Show resolved Hide resolved
"cell_type": "markdown",
"metadata": {},
"source": [
"There are three components of the model that must be specified in order to define events:\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to mention that 2 and 3 are and/or. That is, you can choose to only specify threshold_met or event_state, but often it is beneficial to do both.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. I'll add something and you can take a look

examples/04_New Models.ipynb Outdated Show resolved Hide resolved
"metadata": {},
"outputs": [],
"source": [
"class Batt_newEvent(BatteryElectroChemEOD):\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The casing is a bit awkward to me. Can we call it Batt_NewEvent or BattNewEvent?

examples/04_New Models.ipynb Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

Merging #105 (3037071) into dev (707f9fd) will not change coverage.
Report is 5 commits behind head on dev.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev     #105   +/-   ##
=======================================
  Coverage   84.19%   84.19%           
=======================================
  Files          99       99           
  Lines       10183    10183           
=======================================
  Hits         8574     8574           
  Misses       1609     1609           

@teubert teubert merged commit 8c5e4b8 into dev Oct 11, 2023
11 checks passed
@teubert teubert deleted the examples/custom_event branch October 11, 2023 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants