Release notes from RocketPy

v1.9.0

2025-03-24T16:40:08Z

Release Notes for v1.9.0 🚀

What's Changed

Added

ENH: Parallel mode for Monte-Carlo simulations 2 by @Gui-FernandesBR in [#768](#768)
DOC: ASTRA Flight Example by @LUCKIN13 in [#770](#770)
ENH: Add Eccentricity to Stochastic Simulations by @kevin-alcaniz in [#792](#792)
ENH: Introduce the StochasticAirBrakes class by @kevin-alcaniz in [#785](#785)

Changed

DEP: Remove Pending Deprecations and Add Warnings Where Needed by @MateusStano in [#794](#794)
DOCS: Reshaped documentation (closes #659) by @Gui-FernandesBR in [#781](#781)
MNT: EmptyMotor class inherits from Motor(ABC) by @Gui-FernandesBR in [#779](#779)

Fixed

BUG: Do not allow drawing rockets with no aerodynamic surface by @Gui-FernandesBR in [#774](#774)
BUG: Update flight simulation logic to include burn start time by @Gui-FernandesBR in [#778](#778)
BUG: Fix get_instance_attributes for Flight objects containing a Rocket object without rail buttons by @leogrosa in [#786](#786)
BUG: Fixed AGL altitude print for parachutes with lag by @L30-stack in [#788](#788)
BUG: Fix the wind velocity factors usage and better visualization of uniform distributions in Stochastic Classes by @kevin-alcaniz in [#783](#783)

New Contributors

@L30-stack made their first contribution in [#788](#788)
@leogrosa made their first contribution in [#786](#786)
@kevin-alcaniz made their first contribution in [#783](#783)

Full Changelog: [v1.8.0...v1.9.0](v1.8.0...v1.9.0)

v1.8.0

2025-01-23T01:30:13Z

Release Notes for v1.8.0 🚀

We are excited to announce the release of RocketPy v1.8.0! This version introduces new features, enhancements, and documentation updates to improve your experience. Check out what's new below:

🚀 What's New

Enhancements

Alternative and Custom ODE Solvers: Added support for alternative and custom ODE solvers. (Commit) by @phmbressan
Dataset of Pre-registered Motors: Created a dataset of pre-registered motors for better usability. (PR #744, Commit) by @caioessouza
Encoders Implementation: Expanded encoders implementation to cover full flights. (PR #679, Commit) by @phmbressan.
Monte Carlo Improvements: Enhanced Monte Carlo prints and plots to display more information. (PR #760, Commit) by @EvanMad

Maintenance

Piecewise Functions: Moved piecewise functions to a separate file for better organization. (PR #746, Commit) by @yogirajgutte, @Lucas-Prates, and @Gui-FernandesBR.
CITATION File: Moved the CITATION file back to the root directory. (Commit) by @Gui-FernandesBR.

Documentation

Added several flight simulation examples:
- Defiance Flight Example (PR #742, Commit) by @phmbressan.
- Andromeda 2022 Flight Simulation (PR #754, Commit) by @LUCKIN13
- Lince (Team STAR) 2023 Flight Simulation (PR #752, Commit) by @LUCKIN13.
- Erebus11 - BME Suborbitals - 2022 Flight Simulation (PR #757, Commit) by @LUCKIN13.
Improved flight comparison documentation (PR #755, Commit) by @Gui-FernandesBR.

Testing

Increased test coverage to ensure better reliability. (PR #756, Commit) by @Gui-FernandesBR.

👥 Contributors

A big thank you to all contributors who made this release possible:
@Gui-FernandesBR, @phmbressan, @caioessouza, @LUCKIN13, @EvanMad, @yogirajgutte, @Lucas-Prates, and @ArthurJWH.

Full Changelog: v1.7.1...v1.8.0

v1.7.1

2024-12-07T10:23:59Z

🚀 What's Changed

This is another minor update of RocketPy Python library!

🐛 Bug Fixes:

Fixed the problem with atmospheric conditions after changing date and location.

🔧 Development Improvements:

Testing structure of Tank classes is more organized and up to standard.

✨ Other improvements

Minor improvements to Tank plotting visuals.

📝 Summary of Pull Requests (PRs):

MNT: Refactor Tank's testing Assertion with CAD data. by @phmbressan in #678
BUG: Correctly update atmospheric conditions after changing date and location by @WilliamArmst in #743
DEV: Updates master for v1.7.1 by @phmbressan in #749
REL: update version to 1.7.1 in configuration files. by @phmbressan in #750

Full Changelog: v1.7.0...v1.7.1

v1.7.0

2024-11-30T17:42:45Z

RocketPy v1.7.0 is out!

🚀New features

Optional plot saving: Now you can save plots directly using an optional feature, making data visualization more flexible (#597).
Callback function for Monte Carlo simulations: Added a callback feature to collect additional data during Monte Carlo simulations, offering more customization (#702).

📄Better Documentation

Spherical caps documentation: Fixed and improved the explanation about tanks spherical caps (#728).
RED Flight Example: Added detailed documentation for the RED flight example (#733).
Faraday 2023 Flight Simulation: Included documentation on the Faraday 2023 flight sim (#734).
Developer documentation enhancements: Improved clarity and structure for developer-related resources (#732).

🐛Bug fixes

Sideslip angle and damping coefficient calculation: Fixed an issue impacting the accuracy of these calculations (#729).
Wind speed alignment in weather models: Corrected the position of the wind_speed variable in forecast and reanalysis models (#735).
ECMWF weather model updates: Updated the variables dictionary for better compatibility (#736).
Stochastic fins improvement: Resolved bugs allowing the use of multiple sets of stochastic fins (#737).

📝Pull Requests

Complete description of Pull Requests included in this version:

MNT: refactoring the data folder by @Gui-FernandesBR in #721
MNT: refactoring the data folder (#721) by @Gui-FernandesBR in #726
ENH: Implement optional plot saving by @nalquas in #597
DOC: fixed documentation about spherical caps by @alessio26gas in #728
BUG: Sideslip Angle and Damping Coefficient Calculation by @MateusStano in #729
ENH: Callback function for collecting additional data from Monte Carlo sims by @emtee14 in #702
DOC: RED Flight Example by @LUCKIN13 in #733
DOC: Faraday 2023 flight sim by @LUCKIN13 in #734
BUG: forecast and reanalysis models - move wind_speed to correct position by @WilliamArmst in #735
BUG: forecast and reanalysis models - update ECMWF weather model variables dictionary by @WilliamArmst in #736
BUG: Allow multiple sets of stochastic fins by @WilliamArmst in #737
MNT: Place filename save parameter to the end. by @phmbressan in #739
DOC: improvements to developers documentation by @Gui-FernandesBR in #732
GIT: updates develop from master by @Gui-FernandesBR in #740
GIT: Updates master to v1.7.0 by @Gui-FernandesBR in #731
REL: update version to 1.7.0 in configuration files by @Gui-FernandesBR in #741

New Contributors

We are happy to say welcome to our newest contributors!!

@alessio26gas made their first contribution in #728
@emtee14 made their first contribution in #702
@WilliamArmst made their first contribution in #735

Full Changelog: v1.6.2...v1.7.0

v1.6.2

2024-11-08T21:32:17Z

🚀 What's Changed

This is another magnificent minor update of RocketPy Python library.

🐛 Bug Fixes:

Fixed the problem with the Monte Carlo ellipses export to .kml process
The Ellipses matplotlib plots were also updates, ensuring you can have the best of Monte Carlo simulation results without any problems.

📄Documentation Improvements:

Fixed several minor errors and warning that were arising from the documentation building.
Removed duplicated gitHub icon from the docs page.
Added a new plot comparing simulated vs real apogee data
Our README was also updated!

✨ Other improvements

You can now check the structural to total mass ratio at the Rocket and Motor classes.
We officialized our support to Python 3.13, the newest python version currently live!

📝 Summary of Pull Requests (PRs):

DOC: Fix docs References and Examples Build. by @phmbressan in #711
DOC: new comparison plot by @Gui-FernandesBR in #714
BUG: fix export ellipses to kml function by @Gui-FernandesBR in #712
ENH: add structural to total mass ratio for motor and rocket by @Lucas-Prates in #713
DOC: Updates README by @Gui-FernandesBR in #720
DEV: updates workflows to include python 3.13 by @Gui-FernandesBR in #719
DEV: Updates master for v1.6.2 by @Gui-FernandesBR in #722
REL: rocketpy v1.6.2 by @Gui-FernandesBR in #724

Full Changelog: v1.6.1...v1.6.2

v1.6.1

2024-10-09T19:19:55Z

Installation

One can install this version of RocketPy by running: pip install rocketpy==1.6.1.

Summary

This release brings many bug fixes and a deprecation, see details below:

Deprecation ⚠️

DEP: deprecate NOAA's RuC sounding by @Gui-FernandesBR in #706

Bug Fixes 🛠️

BUG: savetxt Not Accepting lambda Functions by @MateusStano in #698
BUG: Single Point Functions Can Not Be Defined by @MateusStano in #700
BUG: Vector encoding breaks MonteCarlo export. by @phmbressan in #704
BUG: Rail Buttons Not Accepted in Add Surfaces by @MateusStano in #701
BUG: Initialize _Controller Init Parameters by @MateusStano in #703
BUG: Fix Environment.max_expected_height for custom atmosphere by @Gui-FernandesBR in #707
BUG: Fix Motor Zero Dry Mass Check by @laurapgp in #710
REL: v1.6.1 by @Gui-FernandesBR in #708

New Contributors

@laurapgp made their first contribution in #710

Full Changelog: v1.6.0...v1.6.1

v1.6.0

2024-09-29T18:55:08Z

What's Changed

ENH: generic surfaces pylint by @Lucas-Prates in #689
DOC: Generic Surface by @MateusStano in #690
TST: generic surfaces by @Lucas-Prates in #693
ENH: Expand Polation Options for ND Functions. by @phmbressan in #691
ENH: Free-Form Fins by @MateusStano in #694
ENH: Generic Surfaces and Generic Linear Surfaces by @MateusStano in #680
DEV: Prepare Master for v1.6 by @MateusStano in #696
REL: v1.6.0 by @MateusStano in #697

Full Changelog: v1.5.0...v1.6.0

v1.5.0

2024-09-16T00:07:31Z

We're excited to introduce RocketPy v1.5.0! This release includes powerful new features, bug fixes, and documentation improvements to enhance your rocketry simulations. You can now simulate virtual sensors, analyze local sensitivities, and explore additional flight examples! 🎉

New Features ✨

Virtual Sensors: You can now simulate virtual sensors such as Barometers, GNSS Receivers, Accelerometers, and Gyroscopes, expanding your simulation capabilities!
Local Sensitivity Analysis: Run sensitivity analyses on your simulations, making it easier to evaluate the impact of various parameters on the output variables
STFT Function: A Short-Time Fourier Transform (STFT) function has been added to the Function class.
GenericMotor Enhancements: Load engine data directly from .eng files using the new load_from_eng_file() method.
Rocket Axis Definition: Improved rocket axis definitions for clearer, more accurate simulations.

Bug Fixes 🛠️

Zero Mass Flow Issue: Fixed the issue where liquid motors with zero mass flow rates were breaking exhaust velocity calculations.
Rotational Equations of Motion (EOMs): Resolved an issue where rotational EOMs were not relative to the CDM.
Pressure ISA Extrapolation: Corrected the extrapolation method to be linear.
Frequency Response Plot: Fixed issues with the frequency response plot in the Flight class.

Documentation Updates 📚

New Environment Class Docs: Fully updated and enhanced documentation for the Environment class. Check out the new pages for more clarity!
Flight Examples: Two new flight examples—Cavour and Halcyon—have been added to the flight gallery, offering more insights for your simulations.
Documentation Fixes: Various documentation warnings and dependency issues have been resolved.

What's Changed

ENH: Sensors by @MateusStano in #583
ENH: Barometer, ScalarSensors and InertialSensors by @MateusStano in #608
DOC: New Environment class docs pages by @Gui-FernandesBR in #644
DOC: Fix documentation warnings by @Gui-FernandesBR in #645
ENH: Rocket Axes Definition by @MateusStano in #635
DOC: Fix Documentation Requirements. by @phmbressan in #651
DEV: fix tests with numpy2 by @Gui-FernandesBR in #652
ENH: Add STFT function to Function class by @AdvaitChandorkar07 in #620
BUG: fix the Frequency Response plot of Flight class by @Gui-FernandesBR in #653
BUG: Pressure ISA Extrapolation as "linear" by @MateusStano in #675
BUG: Rotational EOMs Not Relative To CDM by @MateusStano in #674
ENH: Adds GNSS Receiver sensor by @MateusStano in #636
ENH: Introducing local sensitivity analysis by @Lucas-Prates in #575
ENH: Adds GenericMotor.load_from_eng_file() method by @juliomachad0 in #676
BUG: Zero Mass Flow Tank causing Empty Velocity Data by @phmbressan in #677
DOC : Halcyon Flight Example by @LUCKIN13 in #681
DOC : Cavour Flight Example by @LUCKIN13 in #682
ENH: Adds Sensors classes by @Gui-FernandesBR in #683
ENH: Fix Orientation Param of Inertial Sensors by @MateusStano in #688
DEV: Updates master to prepare v1.5.0 by @Gui-FernandesBR in #684
REL: bumps rocketpy version to v1.5.0 by @Gui-FernandesBR in #692

New Contributors 👥

@AdvaitChandorkar07 made their first contribution in #620
@LUCKIN13 made their first contribution in #681

Full Changelog: v1.4.3...v1.5.0

v1.4.3

2024-09-11T19:07:42Z

Installation

One can install this version of RocketPy by running: pip install rocketpy==1.4.3

Summary

The main change brought by this release:

BUG: Rollback Prandtl-Glauert corrections for Tail and Nose
- This solves an issue where Prandtl-Glauert corrections regarding compressible flow were not correctly applied to the Tail and Nose of the Rocket.

What's Changed

BUG: Rollback Prandtl-Glauert corrections for Tail and Nose. by @phmbressan in #685
REL: Bump versioning to RocketPy v1.4.3. by @phmbressan in #687

Full Changelog: v1.4.2...v1.4.3

v1.4.2

2024-08-03T16:03:38Z

What's Changed

ENH: adding rocket radius to RailButtons class by @juliomachad0 in #643
BUG: Time Node Merge Not Including Controllers by @MateusStano in #647
REL: Bump versioning to RocketPy v1.4.2 by @Gui-FernandesBR in #648

Full Changelog: v1.4.1...v1.4.2