-
-
Notifications
You must be signed in to change notification settings - Fork 208
Update master with develop to release v1.11.0 #859
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
Merged
Merged
Changes from 23 commits
Commits
Show all changes
28 commits
Select commit
Hold shift + click to select a range
5b625a8
MNT: update develop to release v1.10.0 (#822)
Lucas-Prates 71ed18c
ENH: _MotorPrints inheritance - issue #460 (#828)
Gui-FernandesBR 0f6c701
MNT: fix deprecations and warnings (#829)
Gui-FernandesBR 36190d2
DEV: streamline caching of Python dependencies in GitHub Actions
Gui-FernandesBR 780f724
Merge pull request #832 from RocketPy-Team/dev/fix-pip-cache
Gui-FernandesBR e428604
ENH: Add the Coriolis Force to the Flight class (#799)
kevin-alcaniz 71e2b3a
MNT: deprecated decorator (#830)
Gui-FernandesBR 2940eaa
DEV: GitHub copilot instructions (#831)
Gui-FernandesBR 75b8e5f
BUG: Fixes StochasticNoseCone powerseries issue #838 (#839)
cazzopardi 2a3e846
ENH: Discretized and No-Pickle Encoding Options (#827)
phmbressan 6648899
Merge branch 'master' into develop
Gui-FernandesBR 80d3d5c
DOC: Add Flight class usage documentation and update index (#841)
Gui-FernandesBR b0aacdc
ENH: Add Crop and Clip Methods to Function (#817)
Rickisterr b822b1a
BUG: Fix no time initialization when passing initial_solution as arra…
chasgior214 fdc547a
DEV: update changelog
MateusStano 7846e5a
EHN: Addition of ensemble variable to ECMWF dictionaries (#842)
LUCKIN13 0dbc808
ENH: Improve parachute geometric parametrization (#835)
ArthurJWH f89834b
DOC: Update docs dependencies and sub dependencies (#851)
phmbressan 8c82c3a
ENH: Controller (AirBrakes) and Sensors Encoding (#849)
phmbressan 976617c
ENH: Tank Fluids with Variable Density from Temperature and Pressure …
phmbressan 973398c
mnt/extract flight data exporters (#845)
CameronBrooks11 34c0273
ENH: Changing ellipses plot axis label (#855)
ArthurJWH af7bbff
MNT: bumps min python version to 3.10 (#857)
Gui-FernandesBR 1ea18e7
TST: reorganize test files using different folders (#856)
Gui-FernandesBR 20dc3be
Apply suggestion from @Gui-FernandesBR
MateusStano 3313e08
BUG: correct encoding for trapezoidal sweep length and angle. (#861)
phmbressan 8797068
TST: remove remaining files after test session. (#862)
phmbressan 857c4f4
MNT: allow for exporting of non apogee flights. (#863)
phmbressan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| # GitHub Copilot Instructions for RocketPy | ||
|
|
||
| This file provides instructions for GitHub Copilot when working on the RocketPy codebase. | ||
| These guidelines help ensure consistency with the project's coding standards and development practices. | ||
|
|
||
| ## Project Overview | ||
|
|
||
| RocketPy is a Python library for 6-DOF rocket trajectory simulation. | ||
| It's designed for high-power rocketry applications with focus on accuracy, performance, and ease of use. | ||
|
|
||
| ## Coding Standards | ||
|
|
||
| ### Naming Conventions | ||
| - **Use `snake_case` for all new code** - variables, functions, methods, and modules | ||
| - **Use descriptive names** - prefer `angle_of_attack` over `a` or `alpha` | ||
| - **Class names use PascalCase** - e.g., `SolidMotor`, `Environment`, `Flight` | ||
| - **Constants use UPPER_SNAKE_CASE** - e.g., `DEFAULT_GRAVITY`, `EARTH_RADIUS` | ||
|
|
||
| ### Code Style | ||
| - Follow **PEP 8** guidelines | ||
| - Line length: **88 characters** (Black's default) | ||
| - Organize imports with **isort** | ||
| - Our official formatter is the **ruff frmat** | ||
|
|
||
| ### Documentation | ||
| - **All public classes, methods, and functions must have docstrings** | ||
| - Use **NumPy style docstrings** | ||
| - Include **Parameters**, **Returns**, and **Examples** sections | ||
| - Document **units** for physical quantities (e.g., "in meters", "in radians") | ||
|
|
||
| ### Testing | ||
| - Write **unit tests** for all new features using pytest | ||
| - Follow **AAA pattern** (Arrange, Act, Assert) | ||
| - Use descriptive test names following: `test_methodname_expectedbehaviour` | ||
| - Include test docstrings explaining expected behavior | ||
| - Use **parameterization** for testing multiple scenarios | ||
| - Create pytest fixtures to avoid code repetition | ||
|
|
||
| ## Domain-Specific Guidelines | ||
|
|
||
| ### Physical Units and Conventions | ||
| - **SI units by default** - meters, kilograms, seconds, radians | ||
| - **Document coordinate systems** clearly (e.g., "tail_to_nose", "nozzle_to_combustion_chamber") | ||
| - **Position parameters** are critical - always document reference points | ||
| - Use **descriptive variable names** for physical quantities | ||
|
|
||
| ### Rocket Components | ||
| - **Motors**: SolidMotor, HybridMotor and LiquidMotor classes are children classes of the Motor class | ||
| - **Aerodynamic Surfaces**: They have Drag curves and lift coefficients | ||
| - **Parachutes**: Trigger functions, deployment conditions | ||
| - **Environment**: Atmospheric models, weather data, wind profiles | ||
|
|
||
| ### Mathematical Operations | ||
| - Use **numpy arrays** for vectorized operations (this improves performance) | ||
| - Prefer **scipy functions** for numerical integration and optimization | ||
| - **Handle edge cases** in calculations (division by zero, sqrt of negative numbers) | ||
| - **Validate input ranges** for physical parameters | ||
| - Monte Carlo simulations: sample from `numpy.random` for random number generation and creates several iterations to assess uncertainty in simulations. | ||
|
|
||
| ## File Structure and Organization | ||
|
|
||
| ### Source Code Organization | ||
|
|
||
| Reminds that `rocketpy` is a Python package served as a library, and its source code is organized into several modules to facilitate maintainability and clarity. The following structure is recommended: | ||
|
|
||
| ``` | ||
| rocketpy/ | ||
| ├── core/ # Core simulation classes | ||
| ├── motors/ # Motor implementations | ||
| ├── environment/ # Atmospheric and environmental models | ||
| ├── plots/ # Plotting and visualization | ||
| ├── tools/ # Utility functions | ||
| └── mathutils/ # Mathematical utilities | ||
| ``` | ||
|
|
||
| Please refer to popular Python packages like `scipy`, `numpy`, and `matplotlib` for inspiration on module organization. | ||
|
|
||
| ### Test Organization | ||
| ``` | ||
| tests/ | ||
| ├── unit/ # Unit tests | ||
| ├── integration/ # Integration tests | ||
| ├── acceptance/ # Acceptance tests | ||
| └── fixtures/ # Test fixtures organized by component | ||
| ``` | ||
|
|
||
| ### Documentation Structure | ||
| ``` | ||
| docs/ | ||
| ├── user/ # User guides and tutorials | ||
| ├── development/ # Development documentation | ||
| ├── reference/ # API reference | ||
| ├── examples/ # Flight examples and notebooks | ||
| └── technical/ # Technical documentation | ||
| ``` | ||
|
|
||
| ## Common Patterns and Practices | ||
|
|
||
| ### Error Handling | ||
| - Use **descriptive error messages** with context | ||
| - **Validate inputs** at class initialization and method entry | ||
| - Raise **appropriate exception types** (ValueError, TypeError, etc.) | ||
| - Include **suggestions for fixes** in error messages | ||
|
|
||
| ### Performance Considerations | ||
| - Use **vectorized operations** where possible | ||
| - **Cache expensive computations** when appropriate (we frequently use `cached_property`) | ||
| - Keep in mind that RocketPy must be fast! | ||
|
|
||
| ### Backward Compatibility | ||
| - **Avoid breaking changes** in public APIs | ||
| - Use **deprecation warnings** before removing features | ||
| - **Document code changes** in docstrings and CHANGELOG | ||
|
|
||
| ## AI Assistant Guidelines | ||
|
|
||
| ### Code Generation | ||
| - **Always include docstrings** for new functions and classes | ||
| - **Follow existing patterns** in the codebase | ||
| - **Consider edge cases** and error conditions | ||
|
|
||
| ### Code Review and Suggestions | ||
| - **Check for consistency** with existing code style | ||
| - **Verify physical units** and coordinate systems | ||
| - **Ensure proper error handling** and input validation | ||
| - **Suggest performance improvements** when applicable | ||
| - **Recommend additional tests** for new functionality | ||
|
|
||
| ### Documentation Assistance | ||
| - **Use NumPy docstring format** consistently | ||
| - **Include practical examples** in docstrings | ||
| - **Document physical meanings** of parameters | ||
| - **Cross-reference related functions** and classes | ||
|
|
||
| ## Testing Guidelines | ||
|
|
||
| ### Unit Tests | ||
| - **Test individual methods** in isolation | ||
| - **Use fixtures** from the appropriate test fixture modules | ||
| - **Mock external dependencies** when necessary | ||
| - **Test both happy path and error conditions** | ||
|
|
||
| ### Integration Tests | ||
| - **Test interactions** between components | ||
| - **Verify end-to-end workflows** (Environment → Motor → Rocket → Flight) | ||
|
|
||
| ### Test Data | ||
| - **Use realistic parameters** for rocket simulations | ||
| - **Include edge cases** (very small/large rockets, extreme conditions) | ||
| - **Test with different coordinate systems** and orientations | ||
|
|
||
| ## Project-Specific Considerations | ||
|
|
||
| ### User Experience | ||
| - **Provide helpful error messages** with context and suggestions | ||
| - **Include examples** in docstrings and documentation | ||
| - **Support common use cases** with reasonable defaults | ||
|
|
||
| ## Examples of Good Practices | ||
|
|
||
| ### Function Definition | ||
| ```python | ||
| def calculate_drag_force( | ||
| velocity, | ||
| air_density, | ||
| drag_coefficient, | ||
| reference_area | ||
| ): | ||
| """Calculate drag force using the standard drag equation. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| velocity : float | ||
| Velocity magnitude in m/s. | ||
| air_density : float | ||
| Air density in kg/m³. | ||
| drag_coefficient : float | ||
| Dimensionless drag coefficient. | ||
| reference_area : float | ||
| Reference area in m². | ||
|
|
||
| Returns | ||
| ------- | ||
| float | ||
| Drag force in N. | ||
|
|
||
| Examples | ||
| -------- | ||
| >>> drag_force = calculate_drag_force(100, 1.225, 0.5, 0.01) | ||
| >>> print(f"Drag force: {drag_force:.2f} N") | ||
| """ | ||
| if velocity < 0: | ||
| raise ValueError("Velocity must be non-negative") | ||
| if air_density <= 0: | ||
| raise ValueError("Air density must be positive") | ||
| if reference_area <= 0: | ||
| raise ValueError("Reference area must be positive") | ||
|
|
||
| return 0.5 * air_density * velocity**2 * drag_coefficient * reference_area | ||
| ``` | ||
|
|
||
| ### Test Example | ||
| ```python | ||
| def test_calculate_drag_force_returns_correct_value(): | ||
| """Test drag force calculation with known inputs.""" | ||
| # Arrange | ||
| velocity = 100.0 # m/s | ||
| air_density = 1.225 # kg/m³ | ||
| drag_coefficient = 0.5 | ||
| reference_area = 0.01 # m² | ||
| expected_force = 30.625 # N | ||
|
|
||
| # Act | ||
| result = calculate_drag_force(velocity, air_density, drag_coefficient, reference_area) | ||
|
|
||
| # Assert | ||
| assert abs(result - expected_force) < 1e-6 | ||
| ``` | ||
|
|
||
|
|
||
| Remember: RocketPy prioritizes accuracy, performance, and usability. Always consider the physical meaning of calculations and provide clear, well-documented interfaces for users. |
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
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
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
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.