Skip to content

Commit fadada4

Browse files
MNT: let max_expected_height be optional arg in the Environment
1 parent d75e11c commit fadada4

1 file changed

Lines changed: 11 additions & 5 deletions

File tree

rocketpy/environment/environment.py

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ class Environment:
9393
Environment.topographic_profile_activated : bool
9494
True if the user already set a topographic profile. False otherwise.
9595
Environment.max_expected_height : float
96-
Maximum altitude in meters to keep weather data.
97-
Used especially for plotting range.
98-
Can be altered as desired.
96+
Maximum altitude in meters to keep weather data. The altitude must be
97+
above sea level (ASL). Especially useful for controlling plottings.
98+
Can be altered as desired by doing `max_expected_height = number`.
9999
Environment.pressure_ISA : Function
100100
Air pressure in Pa as a function of altitude as defined by the
101101
`International Standard Atmosphere ISO 2533`. Only defined after load
@@ -270,6 +270,7 @@ def __init__(
270270
elevation=0,
271271
datum="SIRGAS2000",
272272
timezone="UTC",
273+
max_expected_height=80000.0,
273274
):
274275
"""Initialize Environment class, saving launch rail length,
275276
launch date, location coordinates and elevation. Note that
@@ -308,7 +309,12 @@ def __init__(
308309
timezone : string, optional
309310
Name of the time zone. To see all time zones, import pytz and run
310311
print(pytz.all_timezones). Default time zone is "UTC".
311-
312+
max_expected_height : float, optional
313+
Maximum altitude in meters to keep weather data. The altitude must
314+
be above sea level (ASL). Especially useful for visualization.
315+
Can be altered as desired by doing `max_expected_height = number`.
316+
Depending on the atmospheric model, this value may be automatically
317+
mofified.
312318
313319
Returns
314320
-------
@@ -322,7 +328,7 @@ def __init__(
322328
# Initialize launch site details
323329
self.elevation = elevation
324330
self.set_elevation(elevation)
325-
self._max_expected_height = 80000 # default value
331+
self._max_expected_height = max_expected_height
326332

327333
# Initialize plots and prints objects
328334
self.prints = _EnvironmentPrints(self)

0 commit comments

Comments
 (0)