Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
6ae5708
BUG: Fix hard-coded radius value for parachute added mass calculation…
Copilot Mar 14, 2026
ab6dc3d
ENH: get changes from BUG: All NOAA NOMADS Dependent Atmosphere Model…
MateusStano Mar 19, 2026
7d951f5
ENH: Add guidelines for simulation safety, Sphinx documentation, and …
Gui-FernandesBR Mar 20, 2026
22489fa
REL: bump version to 1.12
MateusStano Mar 8, 2026
8d49e5f
ENH: Add explicit timeouts to ThrustCurve API requests and update cha…
Copilot Mar 19, 2026
116f327
ENH: Restore power_off/on_drag as Function objects; add _input attrib…
Copilot Mar 20, 2026
5f1a3eb
MNT: Remove unused imports and deprecated functions from mathutils/fu…
MateusStano Mar 20, 2026
877e147
BUG: Readd SourceType enumeration for function source types and clean…
MateusStano Mar 20, 2026
9d0ec38
BUG: Fix incorrect Jacobian in `only_radial_burn` branch of `SolidMot…
Copilot Mar 20, 2026
b205b75
ENH: move weathercocking_coeff to PointMassRockt
MateusStano Mar 20, 2026
dc6e878
MNT: ruff
MateusStano Mar 20, 2026
df52c15
MNT: fix cyclic import
MateusStano Mar 20, 2026
1f4f792
BUG: Add wraparound logic for wind direction in environment plots (#939)
khushalkottaru Mar 25, 2026
d0ce62a
MNT: add numpy import to test_environment.py
MateusStano Mar 27, 2026
1c59ae3
Merge branch 'develop' into bug/deactivation-opendap-nomads
MateusStano Mar 27, 2026
9cd2d34
MNT: rename constant for wraparound threshold in _break_direction_wra…
MateusStano Mar 27, 2026
5e99b1f
Merge branch 'develop' into bug/deactivation-opendap-nomads
MateusStano Mar 27, 2026
e0173e2
ENH: Adaptive Monte Carlo via Convergence Criteria (#922)
Malmahrouqi3 Mar 29, 2026
5412b34
DOC: add latitude range in docs
MateusStano Mar 31, 2026
036e22e
MNT: remove unnecessary pylint warning
MateusStano Mar 31, 2026
1dc1372
MNT: remove unnecessary pylint warning
MateusStano Mar 31, 2026
264eb4f
DOC: correctly link to WeatherModelMapping
MateusStano Mar 31, 2026
def001c
DOCS: checked todo
MateusStano Mar 31, 2026
1b5d9fe
ENH: address copilot comments
MateusStano Mar 31, 2026
ee2663b
TST: improve tests
MateusStano Apr 1, 2026
061d71c
Merge branch 'bug/deactivation-opendap-nomads' of https://github.com/…
MateusStano Apr 1, 2026
6f9f177
Merge branch 'develop' into bug/deactivation-opendap-nomads
MateusStano Apr 1, 2026
f8811c9
ENH: get changes from BUG: All NOAA NOMADS Dependent Atmosphere Model…
MateusStano Mar 19, 2026
3bca26c
BUG: Fix hard-coded radius value for parachute added mass calculation…
Copilot Mar 14, 2026
7be7721
ENH: Add guidelines for simulation safety, Sphinx documentation, and …
Gui-FernandesBR Mar 20, 2026
abc816c
REL: bump version to 1.12
MateusStano Mar 8, 2026
6e77308
BUG: Add wraparound logic for wind direction in environment plots (#939)
khushalkottaru Mar 25, 2026
6dbfb47
MNT: add numpy import to test_environment.py
MateusStano Mar 27, 2026
11cb8ed
MNT: rename constant for wraparound threshold in _break_direction_wra…
MateusStano Mar 27, 2026
87fd65d
DOC: add latitude range in docs
MateusStano Mar 31, 2026
15edc27
MNT: remove unnecessary pylint warning
MateusStano Mar 31, 2026
015b7a5
MNT: remove unnecessary pylint warning
MateusStano Mar 31, 2026
27dc88e
ENH: address copilot comments
MateusStano Mar 31, 2026
762c4dc
TST: improve tests
MateusStano Apr 1, 2026
06a5034
DOC: correctly link to WeatherModelMapping
MateusStano Mar 31, 2026
18e110c
DOCS: checked todo
MateusStano Mar 31, 2026
059e44d
ENH: Adaptive Monte Carlo via Convergence Criteria (#922)
Malmahrouqi3 Mar 29, 2026
47ad854
DEV: remove unwanted changes from develop
MateusStano Apr 3, 2026
16dd43b
DEV: Update for hotfix
MateusStano Apr 3, 2026
749e8b3
TST: add tests
MateusStano Apr 4, 2026
ade5267
Merge branch 'bug/deactivation-opendap-nomads' of https://github.com/…
MateusStano Apr 4, 2026
e89046b
MNT: remove changes from develop again
MateusStano Apr 4, 2026
badd7e2
MNT: Refactor longitude and latitude index functions
MateusStano Apr 4, 2026
78256b8
MNT: ruff
MateusStano Apr 4, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,27 @@ Attention: The newest changes should be on top -->

### Added

-
-

### Changed

-

### Fixed

-
-

## [v1.12.1] - 2026-04-03

### Fixed

- HOTFIX: Migrate Forecasts to UCAR THREDDS [#943](https://github.com/RocketPy-Team/RocketPy/pull/943)

## [v1.12.0] - 2026-03-08

### Added

- ENH: Air brakes controller functions now support 8-parameter signature [#854](https://github.com/RocketPy-Team/RocketPy/pull/854)
- TST: Add acceptance tests for 3DOF flight simulation based on Bella Lui rocket [#914] (https://github.com/RocketPy-Team/RocketPy/pull/914_
- ENH: Add background map auto download functionality to Monte Carlo plots [#896](https://github.com/RocketPy-Team/RocketPy/pull/896)
- MNT: net thrust addition to 3 dof in flight class [#907] (https://github.com/RocketPy-Team/RocketPy/pull/907)
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
author = "RocketPy Team"

# The full version, including alpha/beta/rc tags
release = "1.12.0"
release = "1.12.1"


# -- General configuration ---------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/user/compare_flights.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ This is done following the same steps as in the :ref:`firstsimulation` example.

.. jupyter-execute::

after_tomorrow = datetime.now() + timedelta(days=2)
env = Environment(latitude=-23, longitude=-49, date=after_tomorrow)
tomorrow = datetime.now() + timedelta(days=1)
env = Environment(latitude=-23, longitude=-49, date=tomorrow)
env.set_atmospheric_model(type="Forecast", file="GFS")

cesaroni_motor = SolidMotor(
Expand Down
34 changes: 23 additions & 11 deletions docs/user/environment/1-atm-models/ensemble.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _ensemble_atmosphere:

Ensemble
========

Expand All @@ -21,7 +23,21 @@ Ensemble Forecast
Global Ensemble Forecast System (GEFS)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ``GEFS`` model is a global ensemble forecast model ...
.. danger::

**GEFS shortcut unavailable**: ``file="GEFS"`` is currently disabled in
RocketPy because NOMADS OPeNDAP is deactivated for this endpoint.

.. note::

If you have a GEFS-compatible NetCDF or OPeNDAP dataset from another
provider (or a local copy), you can still load it explicitly by passing the
dataset path/URL in ``file`` and a compatible mapping in ``dictionary``.


The ``GEFS`` model is a global ensemble forecast system useful for uncertainty
analysis, but RocketPy's automatic ``file="GEFS"`` shortcut is temporarily
disabled.


.. code-block:: python
Expand Down Expand Up @@ -71,20 +87,16 @@ CMC Ensemble
resulted in a change of the model's endpoint. Efforts are underway to \
restore access to the CMC Ensemble model as swiftly as possible.

.. code-block:: python
At the moment, there is no built-in ``file="CMC"`` shortcut in
``Environment.set_atmospheric_model``.

env_cmc = Environment(
date=date_info,
latitude=-21.960641,
longitude=-47.482122,
elevation=640,
)
env_cmc.set_atmospheric_model(type="Ensemble", file="CMC")
env_cmc.all_info()
If you have a CMC-compatible NetCDF or OPeNDAP dataset, load it explicitly by
passing the dataset path/URL in ``file`` and a matching mapping dictionary in
``dictionary``.


Ensemble Reanalysis
-------------------

Ensemble reanalyses are also possible with RocketPy. See the
:ref:`reanalysis_ensemble` section for more information.
:ref:`reanalysis_ensemble` section for more information.
40 changes: 9 additions & 31 deletions docs/user/environment/1-atm-models/forecast.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Global Forecast System (GFS)

Using the latest forecast from GFS is simple.
Set the atmospheric model to ``forecast`` and specify that GFS is the file you want.
Note that since data is downloaded from the NOMADS server, this line of code can
Note that since data is downloaded from a remote OPeNDAP server, this line of code can
take longer than usual.

.. jupyter-execute::
Expand Down Expand Up @@ -111,36 +111,15 @@ The same coordinates for SpacePort America will be used.
High Resolution Window (HIRESW)
-------------------------------

The High Resolution Window (HIRESW) model is a sophisticated weather forecasting
system that operates at a high spatial resolution of approximately 3 km.
It utilizes two main dynamical cores: the Advanced Research WRF (WRF-ARW) and
the Finite Volume Cubed Sphere (FV3), each designed to enhance the accuracy of
weather predictions.
.. danger::

You can easily set up HIRESW in RocketPy by specifying the date, latitude, and
longitude of your location. Let's use SpacePort America as an example.
**HIRESW shortcut unavailable**: ``file="HIRESW"`` is currently disabled in
RocketPy because NOMADS OPeNDAP is deactivated for this endpoint.

.. jupyter-execute::

env_hiresw = Environment(
date=tomorrow,
latitude=32.988528,
longitude=-106.975056,
)
If you have a HIRESW-compatible dataset from another provider (or a local copy),
you can still load it explicitly by passing the path/URL in ``file`` and an
appropriate mapping in ``dictionary``.

env_hiresw.set_atmospheric_model(
type="Forecast",
file="HIRESW",
dictionary="HIRESW",
)

env_hiresw.plots.atmospheric_model()

.. note::

The HRES model is updated every 12 hours, providing forecasts with a \
resolution of 3 km. The model can predict weather conditions up to 48 hours \
in advance. RocketPy uses the CONUS domain with ARW core.


Using Windy Atmosphere
Expand Down Expand Up @@ -248,6 +227,5 @@ Also, the servers may be down or may face high traffic.

.. seealso::

To see a complete list of available models on the NOAA's NOMADS server, visit
`NOMADS <https://nomads.ncep.noaa.gov/>`_.

To browse available NCEP model collections on UCAR THREDDS, visit
`THREDDS NCEP Catalog <https://thredds.ucar.edu/thredds/catalog/grib/NCEP/GFS/Global_0p25deg/catalog.html>`_.
25 changes: 8 additions & 17 deletions docs/user/environment/1-atm-models/soundings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,31 +57,22 @@ This service allows users to download virtual soundings from numerical weather
prediction models such as GFS, RAP, and NAM, and also real soundings from the
Integrated Global Radiosonde Archive (IGRA).

These options can be retrieved as a text file in GSD format.
By generating such a file through the link above, the file's URL can be used to
import the atmospheric data into RocketPy.

We will use the same sounding station as we did for the Wyoming Soundings.
These options can be retrieved as a text file in GSD format. However,
RocketPy no longer provides a dedicated ``set_atmospheric_model`` type for
NOAA RUC Soundings.

.. note::

Select ROABs as the initial data source, specify the station through its \
WMO-ID, and opt for the ASCII (GSD format) button.

Initialize a new Environment instance:

.. code-block:: python
If you need to use RUC-sounding-like data in RocketPy, convert it to one of the
supported workflows:

url = r"https://rucsoundings.noaa.gov/get_raobs.cgi?data_source=RAOB&latest=latest&start_year=2019&start_month_name=Feb&start_mday=5&start_hour=12&start_min=0&n_hrs=1.0&fcst_len=shortest&airport=83779&text=Ascii%20text%20%28GSD%20format%29&hydrometeors=false&start=latest"
env = Environment()
env.set_atmospheric_model(type="NOAARucSounding", file=url)
env.plots.atmospheric_model()
- Use :ref:`custom_atmosphere` after parsing the text data.
- Use :ref:`reanalysis` or :ref:`forecast` with NetCDF/OPeNDAP sources.

.. note::

The leading `r` in the URL string is used to indicate a raw string, which \
is useful when dealing with backslashes in URLs.



is useful when dealing with backslashes in URLs.
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _standard_atmosphere:

Standard Atmosphere
===================

Expand Down Expand Up @@ -29,4 +31,4 @@ The International Standard Atmosphere can also be reset at any time by using the

.. jupyter-execute::

env.set_atmospheric_model(type="standard_atmosphere")
env.set_atmospheric_model(type="standard_atmosphere")
96 changes: 86 additions & 10 deletions docs/user/environment/3-further/other_apis.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _environment_other_apis:

Connecting to other APIs
========================

Expand Down Expand Up @@ -25,14 +27,19 @@ the following dimensions and variables:
- Latitude
- Longitude
- Pressure Levels
- Temperature (as a function of Time, Pressure Levels, Latitude and Longitude)
- Geopotential Height (as a function of Time, Pressure Levels, Latitude and Longitude)
- or Geopotential (as a function of Time, Pressure Levels, Latitude and Longitude)
- Surface Geopotential Height (as a function of Time, Latitude and Longitude)
(optional)
- Wind - U Component (as a function of Time, Pressure Levels, Latitude and Longitude)
- Wind - V Component (as a function of Time, Pressure Levels, Latitude and Longitude)

Some projected grids also require a ``projection`` key in the mapping.


For example, let's imagine we want to use the HIRESW model from this endpoint:
`https://nomads.ncep.noaa.gov/dods/hiresw/ <https://nomads.ncep.noaa.gov/dods/hiresw/>`_
For example, let's imagine we want to use a forecast model available via an
OPeNDAP endpoint.


Looking through the variable list in the link above, we find the following correspondence:
Expand Down Expand Up @@ -72,15 +79,85 @@ Therefore, we can create an environment like this:
dictionary=name_mapping,
)

Built-in mapping dictionaries
-----------------------------

Instead of a custom dictionary, you can pass a built-in mapping name in the
``dictionary`` argument. Common options include:

- ``"ECMWF"``
- ``"ECMWF_v0"``
- ``"NOAA"``
- ``"GFS"``
- ``"NAM"``
- ``"RAP"``
- ``"HIRESW"`` (mapping available; latest-model shortcut currently disabled)
- ``"GEFS"`` (mapping available; latest-model shortcut currently disabled)
- ``"MERRA2"``
- ``"CMC"`` (for compatible datasets loaded explicitly)

What a mapping name means
^^^^^^^^^^^^^^^^^^^^^^^^^

- Base mapping names (for example ``"GFS"``, ``"NAM"`` and ``"RAP"``) map
RocketPy weather keys to the current default variable naming used by the
corresponding provider datasets.
- These defaults are aligned with current shortcut workflows (for example,
THREDDS-backed latest model sources) and may use projected coordinates
(``x``/``y`` plus ``projection``) depending on the model.

Legacy mapping names
^^^^^^^^^^^^^^^^^^^^

If you are loading archived or older NOMADS-style datasets, use the explicit
legacy aliases:

- ``"GFS_LEGACY"``
- ``"NAM_LEGACY"``
- ``"NOAA_LEGACY"``
- ``"RAP_LEGACY"``
- ``"CMC_LEGACY"``
- ``"GEFS_LEGACY"``
- ``"HIRESW_LEGACY"``
- ``"MERRA2_LEGACY"``

Legacy aliases primarily cover older variable naming patterns such as
``lev``, ``tmpprs``, ``hgtprs``, ``ugrdprs`` and ``vgrdprs``.

.. note::

Mapping names are case-insensitive. For example,
``"gfs_legacy"`` and ``"GFS_LEGACY"`` are equivalent.

For custom dictionaries, the canonical structure is:

.. code-block:: python

mapping = {
"time": "time",
"latitude": "lat",
"longitude": "lon",
"level": "lev",
"temperature": "tmpprs",
"surface_geopotential_height": "hgtsfc", # optional
"geopotential_height": "hgtprs", # or geopotential
"geopotential": None,
"u_wind": "ugrdprs",
"v_wind": "vgrdprs",
}

.. important::

Ensemble datasets require an additional key for member selection:
``"ensemble": "<your_member_dimension_name>"``.

.. caution::

Notice the ``file`` argument were suppressed in the code above. This is because \
the URL depends on the date you are running the simulation. For example, as \
it for now, a possible link could be: https://nomads.ncep.noaa.gov/dods/hiresw/hiresw20240803/hiresw_conusfv3_12z \
(for the 3rd of August, 2024, at 12:00 UTC). \
You should replace the date in the URL with the date you are running the simulation. \
Different models may have different URL structures, so be sure to check the \
documentation of the model you are using.
The ``file`` argument was intentionally omitted in the example above. This is
because the URL depends on the provider, dataset, and date you are running
the simulation. Build the endpoint according to the provider specification
and always validate that the target service is active before running your
simulation workflow.


Without OPeNDAP protocol
Expand All @@ -94,4 +171,3 @@ Environment class, for example:

- `Meteomatics <https://www.meteomatics.com/en/weather-api/>`_: `#545 <https://github.com/RocketPy-Team/RocketPy/issues/545>`_
- `Open-Meteo <https://open-meteo.com/>`_: `#520 <https://github.com/RocketPy-Team/RocketPy/issues/520>`_

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "rocketpy"
version = "1.12.0"
version = "1.12.1"
description="Advanced 6-DOF trajectory simulation for High-Power Rocketry."
dynamic = ["dependencies"]
readme = "README.md"
Expand Down
Loading