Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
05ab711
Add the function to create a motor from the API of thrustcurve and th…
Marchma0 Nov 4, 2025
da39fcb
Improve load_from_thrustcurve_api and test_load_from_thrustcurve_api …
Monta120 Nov 4, 2025
9fdc704
Clean up load_from_thrustcurve_api and improve test_load_from_thrustc…
Monta120 Nov 5, 2025
d123b47
Use warnings.warn() in load_from_thrustcurve_api when motor is found …
Monta120 Nov 5, 2025
d6c5dee
Added documentation for the load_from_thrustcurve_api method into the…
Monta120 Nov 5, 2025
142eaf8
Changes to conform to lint
Marchma0 Nov 12, 2025
361ffab
Fixed Pylint errors
Marchma0 Nov 17, 2025
55beb5a
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
731eb30
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
f5e470e
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
ee61517
Set private the method call_thrustcurve_api
Marchma0 Nov 26, 2025
cf2013f
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
068362a
Update tests/unit/motors/test_genericmotor.py
Marchma0 Nov 26, 2025
a319ab6
Update rocketpy/motors/motor.py
Marchma0 Nov 26, 2025
4555a2d
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
7c7e079
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
04ce65e
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
b68b404
Modify the changelog
Marchma0 Nov 26, 2025
be79157
Bug fix
Marchma0 Nov 26, 2025
90aac5f
Refactor GenericMotor class: comment out unused designation and manuf…
Gui-FernandesBR Nov 27, 2025
22ea545
Add the function to create a motor from the API of thrustcurve and th…
Marchma0 Nov 4, 2025
9315bd4
Improve load_from_thrustcurve_api and test_load_from_thrustcurve_api …
Monta120 Nov 4, 2025
df3335a
Clean up load_from_thrustcurve_api and improve test_load_from_thrustc…
Monta120 Nov 5, 2025
eb47e31
Use warnings.warn() in load_from_thrustcurve_api when motor is found …
Monta120 Nov 5, 2025
505a9fa
Added documentation for the load_from_thrustcurve_api method into the…
Monta120 Nov 5, 2025
9ac9bcc
Changes to conform to lint
Marchma0 Nov 12, 2025
c4bf266
Fixed Pylint errors
Marchma0 Nov 17, 2025
94fa35e
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
d50c03f
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
d3f0997
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
ea1ed6e
Set private the method call_thrustcurve_api
Marchma0 Nov 26, 2025
eda5e5a
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
15f12c4
Update tests/unit/motors/test_genericmotor.py
Marchma0 Nov 26, 2025
ddbc22d
Update rocketpy/motors/motor.py
Marchma0 Nov 26, 2025
18a0fcb
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
fb8db26
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
0d6fb34
Update docs/user/motors/genericmotor.rst
Marchma0 Nov 26, 2025
3d53911
Modify the changelog
Marchma0 Nov 26, 2025
a048bb4
Bug fix
Marchma0 Nov 26, 2025
f1cf70a
Merge branch 'enh/motor-thrustcurve-api' of https://github.com/idl-im…
Gui-FernandesBR Nov 27, 2025
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
80 changes: 80 additions & 0 deletions docs/user/motors/genericmotor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,83 @@ note that the user can still provide the parameters manually if needed.
The ``load_from_eng_file`` method is a very useful tool for simulating motors \
when the user does not have all the information required to build a ``SolidMotor`` yet.

The ``load_from_thrustcurve_api`` method
---------------------------------------

The ``GenericMotor`` class provides a convenience loader that downloads a temporary
`.eng` file from the ThrustCurve.org public API and builds a ``GenericMotor``
instance from it. This is useful when you know a motor designation (for example
``"M1670"``) but do not want to manually download and
save the `.eng` file.

.. note::

This method performs network requests to the ThrustCurve API. Use it only
when you have network access. For automated testing or reproducible runs,
prefer using local `.eng` files.
Signature
----------

``GenericMotor.load_from_thrustcurve_api(name: str, **kwargs) -> GenericMotor``

Parameters
----------
name : str
Motor name to search on ThrustCurve (example:
``"M1670"``).Only shorthand names are accepted (e.g. ``"M1670"``, not
``"Cesaroni M1670"``).
when multiple matches occur the first result returned by the API is used.
**kwargs :
Same optional arguments accepted by the :class:`GenericMotor` constructor
(e.g. ``dry_mass``, ``nozzle_radius``, ``interpolation_method``). Any
parameters provided here override values parsed from the downloaded file.

Returns
----------
GenericMotor
A new ``GenericMotor`` instance created from the .eng data downloaded from
ThrustCurve.

Raises
----------
ValueError
If the API search returns no motor, or if the download endpoint returns no
.eng file or empty/invalid data.
requests.exceptions.RequestException

Behavior notes
---------------
- The method first performs a search on ThrustCurve using the provided name.
If no results are returned a :class:`ValueError` is raised.
- If a motor is found the method requests the .eng file in RASP format, decodes
it and temporarily writes it to disk; a ``GenericMotor`` is then constructed
using the existing .eng file loader. The temporary file is removed even if an
error occurs.
- The function emits a non-fatal informational warning when a motor is found
(``warnings.warn(...)``). This follows the repository convention for
non-critical messages; callers can filter or suppress warnings as needed.

Example
---------------

.. jupyter-execute::

from rocketpy.motors import GenericMotor

# Build a motor by name (requires network access)
motor = GenericMotor.load_from_thrustcurve_api("M1670")

# Use the motor as usual
motor.info()

Testing advice
---------------
- ``pytest``'s ``caplog`` or ``capfd`` to assert on log/warning output.

Security & reliability
----------------
- The method makes outgoing HTTP requests and decodes base64-encoded content;
validate inputs in upstream code if you accept motor names from untrusted
sources.
- Network failures, API rate limits, or changes to the ThrustCurve API may
break loading; consider caching downloaded `.eng` files for production use.
120 changes: 119 additions & 1 deletion rocketpy/motors/motor.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
import base64
import re
import tempfile
import warnings
import xml.etree.ElementTree as ET
from abc import ABC, abstractmethod
from functools import cached_property
from os import path
from os import path, remove

import numpy as np
import requests

from ..mathutils.function import Function, funcify_method
from ..plots.motor_plots import _MotorPlots
Expand Down Expand Up @@ -1914,6 +1917,121 @@ def load_from_rse_file(
coordinate_system_orientation=coordinate_system_orientation,
)

@staticmethod
def call_thrustcurve_api(name: str):
"""
Download a .eng file from the ThrustCurve API
based on the given motor name.

Parameters
----------
name : str
The motor name according to the API (e.g., "Cesaroni_M1670" or "M1670").
Both manufacturer-prefixed and shorthand names are commonly used; if multiple
motors match the search, the first result is used.

Returns
-------
data_base64 : String
The .eng file of the motor in base64

Raises
------
ValueError
If no motor is found or if the downloaded .eng data is missing.
requests.exceptions.RequestException
If a network or HTTP error occurs during the API call.
"""
base_url = "https://www.thrustcurve.org/api/v1"

# Step 1. Search motor
response = requests.get(f"{base_url}/search.json", params={"commonName": name})
response.raise_for_status()
data = response.json()

if not data.get("results"):
raise ValueError(
f"No motor found for name '{name}'. "
"Please verify the motor name format (e.g., 'Cesaroni_M1670' or 'M1670') and try again."
)

motor_info = data["results"][0]
motor_id = motor_info.get("motorId")
designation = motor_info.get("designation", "").replace("/", "-")
manufacturer = motor_info.get("manufacturer", "")
warnings.warn(f"Motor found: {designation} ({manufacturer})", UserWarning)

# Step 2. Download the .eng file
dl_response = requests.get(
f"{base_url}/download.json",
params={"motorIds": motor_id, "format": "RASP", "data": "file"},
)
dl_response.raise_for_status()
dl_data = dl_response.json()

if not dl_data.get("results"):
raise ValueError(
f"No .eng file found for motor '{name}' in the ThrustCurve API."
)

data_base64 = dl_data["results"][0].get("data")
if not data_base64:
raise ValueError(
f"Downloaded .eng data for motor '{name}' is empty or invalid."
)
return data_base64

@staticmethod
def load_from_thrustcurve_api(name: str, **kwargs):
"""
Creates a Motor instance by downloading a .eng file from the ThrustCurve API
based on the given motor name.

Parameters
----------
name : str
The motor name according to the API (e.g., "Cesaroni_M1670" or "M1670").
Both manufacturer-prefixed and shorthand names are commonly used; if multiple
motors match the search, the first result is used.
**kwargs :
Additional arguments passed to the Motor constructor or loader, such as
dry_mass, nozzle_radius, etc.

Returns
-------
instance : GenericMotor
A new GenericMotor instance initialized using the downloaded .eng file.

Raises
------
ValueError
If no motor is found or if the downloaded .eng data is missing.
requests.exceptions.RequestException
If a network or HTTP error occurs during the API call.
"""

data_base64 = GenericMotor.call_thrustcurve_api(name)
data_bytes = base64.b64decode(data_base64)

# Step 3. Create the motor from the .eng file
tmp_path = None
try:
# create a temporary file that persists until we explicitly remove it
with tempfile.NamedTemporaryFile(suffix=".eng", delete=False) as tmp_file:
tmp_file.write(data_bytes)
tmp_file.flush()
tmp_path = tmp_file.name

return GenericMotor.load_from_eng_file(tmp_path, **kwargs)
finally:
# Ensuring the temporary file is removed
if tmp_path and path.exists(tmp_path):
try:
remove(tmp_path)
except OSError:
# If cleanup fails, don't raise: we don't want to mask prior exceptions.
pass

def all_info(self):
"""Prints out all data and graphs available about the Motor."""
# Print motor details
Expand Down
114 changes: 114 additions & 0 deletions tests/unit/motors/test_genericmotor.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import base64

import numpy as np
import pytest
import requests
import scipy.integrate

from rocketpy import Function, Motor
Expand Down Expand Up @@ -211,3 +214,114 @@ def test_load_from_rse_file(generic_motor):
assert thrust_curve[0][1] == 0.0 # First thrust point
assert thrust_curve[-1][0] == 2.2 # Last point of time
assert thrust_curve[-1][1] == 0.0 # Last thrust point


class MockResponse:
"""Mocked response for requests."""

def __init__(self, json_data):
self._json_data = json_data

def json(self):
return self._json_data

def raise_for_status(self):
return None


def _mock_get(search_results=None, download_results=None):
"""Return a mock_get function with predefined search/download results."""

def _get(url, **_kwargs):
if "search.json" in url:
return MockResponse(search_results or {"results": []})
if "download.json" in url:
return MockResponse(download_results or {"results": []})
raise RuntimeError(f"Unexpected URL: {url}")

return _get


def assert_motor_specs(motor):
burn_time = (0, 3.9)
dry_mass = 2.130
propellant_initial_mass = 3.101
chamber_radius = 75 / 1000
chamber_height = 757 / 1000
nozzle_radius = chamber_radius * 0.85
average_thrust = 1545.218
total_impulse = 6026.350
max_thrust = 2200.0
exhaust_velocity = 1943.357

assert motor.burn_time == burn_time
assert motor.dry_mass == dry_mass
assert motor.propellant_initial_mass == propellant_initial_mass
assert motor.chamber_radius == chamber_radius
assert motor.chamber_height == chamber_height
assert motor.chamber_position == 0
assert motor.average_thrust == pytest.approx(average_thrust)
assert motor.total_impulse == pytest.approx(total_impulse)
assert motor.exhaust_velocity.average(*burn_time) == pytest.approx(exhaust_velocity)
assert motor.max_thrust == pytest.approx(max_thrust)
assert motor.nozzle_radius == pytest.approx(nozzle_radius)


def test_load_from_thrustcurve_api(monkeypatch, generic_motor):
"""Tests GenericMotor.load_from_thrustcurve_api with mocked API."""

eng_path = "data/motors/cesaroni/Cesaroni_M1670.eng"
with open(eng_path, "rb") as f:
encoded = base64.b64encode(f.read()).decode("utf-8")

search_json = {
"results": [
{
"motorId": "12345",
"designation": "Cesaroni_M1670",
"manufacturer": "Cesaroni",
}
]
}
download_json = {"results": [{"data": encoded}]}
monkeypatch.setattr(requests, "get", _mock_get(search_json, download_json))
monkeypatch.setattr(requests.Session, "get", _mock_get(search_json, download_json))

motor = type(generic_motor).load_from_thrustcurve_api("M1670")

assert_motor_specs(motor)

_, _, points = Motor.import_eng(eng_path)
assert motor.thrust.y_array == pytest.approx(
Function(points, "Time (s)", "Thrust (N)", "linear", "zero").y_array
)

error_cases = [
("No motor found", {"results": []}, None),
(
"No .eng file found",
{
"results": [
{"motorId": "123", "designation": "Fake", "manufacturer": "Test"}
]
},
{"results": []},
),
(
"Downloaded .eng data",
{
"results": [
{"motorId": "123", "designation": "Fake", "manufacturer": "Test"}
]
},
{"results": [{"data": ""}]},
),
]

for msg, search_res, download_res in error_cases:
monkeypatch.setattr(requests, "get", _mock_get(search_res, download_res))
monkeypatch.setattr(
requests.Session, "get", _mock_get(search_res, download_res)
)
with pytest.raises(ValueError, match=msg):
type(generic_motor).load_from_thrustcurve_api("FakeMotor")
Loading