Skip to content

Conversation

lymichelle21
Copy link
Contributor

@lymichelle21 lymichelle21 commented Apr 15, 2025

  • Add table of contents
  • Fix formatting for consistency

Copy link

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.

@lymichelle21 lymichelle21 changed the title Update New Physics-Based Prognostic Models Notebook Update new physics-based prognostic models notebook Apr 15, 2025
@lymichelle21 lymichelle21 changed the title Update new physics-based prognostic models notebook Update physics-based prognostic models notebook Apr 15, 2025
@lymichelle21 lymichelle21 added the documentation Improvements or additions to documentation, examples, or tutorial label Apr 15, 2025
@lymichelle21 lymichelle21 marked this pull request as ready for review April 22, 2025 14:45
Copy link
Contributor

@kjjarvis kjjarvis left a comment

Choose a reason for hiding this comment

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

Two very small edits but this looks great and everything runs successfully.

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.

Great work. Added a few minor comments.

"## Table of Contents\n",
"* [Linear Models](#Linear-Models)\n",
"* [New State Transition Models](#New-State-Transition-Models)\n",
"* [Derived Parameters](#Derived-Parameters)\n",
Copy link
Contributor

Choose a reason for hiding this comment

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

Organization thought. Maybe we should put all these features into a section for ease of navigation. So the sections would be:

  • Linear Models
  • State Transition Models
  • Advanced Features - with everything there as subsections
  • Simplified Battery Model Example
  • Conclusion

What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Having an advanced features section makes sense since the subsections like derived parameters, matrix data access, state limits, custom events, and serialization all focus on optional features for the models.

I'm assuming direct models should be its own section instead of a subsection?

lymichelle21 and others added 5 commits April 23, 2025 12:49
Co-authored-by: Christopher Teubert <christopher.a.teubert@nasa.gov>
Co-authored-by: Katy Jarvis Griffith <55932920+kjjarvis@users.noreply.github.com>
@lymichelle21 lymichelle21 force-pushed the update-notebook-new-models branch from 5ee4a4e to 18a8e16 Compare April 23, 2025 21:12
@teubert teubert closed this Apr 24, 2025
@teubert teubert deleted the update-notebook-new-models branch April 24, 2025 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation, examples, or tutorial

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants