Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds SFPE Handbook Chapter 59 to the Rust sfpe_handbook crate and exposes the implemented equations (59.5–59.9) through the PyO3 ofire Python API, with Sphinx API documentation updates.
Changes:
- Introduces Chapter 59 Rust modules with equation implementations and unit tests for equations 59.5–59.9.
- Adds Python bindings (PyO3) for Chapter 59 equations and wires the new chapter into the
sfpe_handbookPython module. - Updates Sphinx docs to include Chapter 59 modules; includes minor formatting cleanups in Chapter 50 files.
Reviewed changes
Copilot reviewed 20 out of 23 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| crates/sfpe_handbook/src/lib.rs | Exposes chapter_59 from the Rust SFPE Handbook crate. |
| crates/sfpe_handbook/src/chapter_59.rs | Declares Chapter 59 equation submodules. |
| crates/sfpe_handbook/src/chapter_59/equation_59_5.rs | Implements Eq. 59.5 (travel speed) + tests + equation-string helper. |
| crates/sfpe_handbook/src/chapter_59/equation_59_6.rs | Implements Eq. 59.6 (specific flow) + tests + equation-string helper. |
| crates/sfpe_handbook/src/chapter_59/equation_59_7.rs | Implements Eq. 59.7 (combined specific flow) + tests + equation-string helper. |
| crates/sfpe_handbook/src/chapter_59/equation_59_8.rs | Implements Eq. 59.8 (calculated flow) + tests + equation-string helper. |
| crates/sfpe_handbook/src/chapter_59/equation_59_9.rs | Implements Eq. 59.9 (combined calculated flow) + tests + equation-string helper. |
| crates/sfpe_handbook/src/chapter_59/equation_59_10.rs | Adds an unimplemented placeholder (currently panics). |
| crates/sfpe_handbook/src/chapter_59/equation_59_11.rs | Adds an unimplemented placeholder (currently panics). |
| crates/sfpe_handbook/src/chapter_50/equation_50_17.rs | Formatting-only change to the equation-string helper signature. |
| crates/sfpe_handbook/src/chapter_50/equation_50_16.rs | Formatting-only whitespace cleanup. |
| crates/python_api/src/sfpe_handbook.rs | Exposes chapter_59 in the Python API sfpe_handbook module. |
| crates/python_api/src/sfpe_handbook/chapter_59.rs | Adds Chapter 59 Python submodule wiring (wrap_pymodule). |
| crates/python_api/src/sfpe_handbook/chapter_59/equation_59_5.rs | PyO3 binding + docstring for Eq. 59.5. |
| crates/python_api/src/sfpe_handbook/chapter_59/equation_59_6.rs | PyO3 binding + docstring for Eq. 59.6. |
| crates/python_api/src/sfpe_handbook/chapter_59/equation_59_7.rs | PyO3 binding + docstring for Eq. 59.7. |
| crates/python_api/src/sfpe_handbook/chapter_59/equation_59_8.rs | PyO3 binding + docstring for Eq. 59.8. |
| crates/python_api/src/sfpe_handbook/chapter_59/equation_59_9.rs | PyO3 binding + docstring for Eq. 59.9. |
| crates/python_api/src/sfpe_handbook/chapter_59/equation_59_10.rs | PyO3 placeholder returning NotImplementedError + placeholder docs. |
| crates/python_api/src/sfpe_handbook/chapter_59/equation_59_11.rs | PyO3 placeholder returning NotImplementedError + placeholder docs. |
| crates/python_api/src/sfpe_handbook/chapter_50/equation_50_20.rs | Formatting-only trailing brace alignment. |
| crates/python_api/src/sfpe_handbook/chapter_50/equation_50_17.rs | Formatting-only trailing brace alignment. |
| crates/python_api/docs/api/sfpe-handbook.rst | Adds Chapter 59 API documentation entries. |
You can also share your feedback on Copilot code review. Take the survey.
crates/python_api/src/sfpe_handbook/chapter_59/equation_59_10.rs
Outdated
Show resolved
Hide resolved
crates/python_api/src/sfpe_handbook/chapter_59/equation_59_11.rs
Outdated
Show resolved
Hide resolved
Contributor
Author
|
@JamieMaclean |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Equations for 1st order hydraulic model. Still missing 59-10 and 59-11