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

Adding Composite Model Example #103

Merged
merged 5 commits into from
Oct 6, 2023
Merged

Adding Composite Model Example #103

merged 5 commits into from
Oct 6, 2023

Conversation

teubert
Copy link
Contributor

@teubert teubert commented Oct 4, 2023

Adding the first example from 06 Combined Model. This is for composite models. Also added inputs, states, and outputs description to propeller load.

@github-actions
Copy link

github-actions bot commented Oct 4, 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.

@codecov-commenter
Copy link

Codecov Report

Merging #103 (1b884ee) into dev (b4637f7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev     #103   +/-   ##
=======================================
  Coverage   84.19%   84.19%           
=======================================
  Files          99       99           
  Lines       10183    10183           
=======================================
  Hits         8574     8574           
  Misses       1609     1609           
Files Coverage Δ
src/progpy/models/propeller_load.py 100.00% <ø> (ø)

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.

This looks good. Just a few suggestions of additions that may add a little clarity

examples/06_Combining_Models.ipynb Outdated Show resolved Hide resolved
examples/06_Combining_Models.ipynb Outdated Show resolved Hide resolved
examples/06_Combining_Models.ipynb Outdated Show resolved Hide resolved
"cell_type": "markdown",
"metadata": {},
"source": [
"Next we have to define the connections between the systems. Let's first define the connections from the DCMotor to the propeller load."
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion to add to the end, just so it's clear, "For this, we'll need to look at the DCMotor states and understand how they influence the PropellerLoad inputs".

examples/06_Combining_Models.ipynb Outdated Show resolved Hide resolved
examples/06_Combining_Models.ipynb Outdated Show resolved Hide resolved
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.

This looks great! I think these additions make everything flow smoothly. Great example

examples/06_Combining_Models.ipynb Outdated Show resolved Hide resolved
teubert and others added 2 commits October 6, 2023 09:21
Co-authored-by: Katy Jarvis Griffith <55932920+kjjarvis@users.noreply.github.com>
@teubert teubert merged commit 707f9fd into dev Oct 6, 2023
26 of 28 checks passed
@teubert teubert deleted the examples/composite branch October 7, 2023 00: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