Skip to content

Commit d95f70a

Browse files
Gui-FernandesBRLucas-Prates
Gui-FernandesBR
and
Lucas-Prates
committed
DOC: environment docstrings minor fixes
Update docs/user/environment/0-setup/elevation.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/0-setup/elevation.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/0-setup/index.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/3-further/data_csv.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/2-earth-models/topography.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com> Update docs/user/environment/1-atm-models/forecast.rst Co-authored-by: Lucas Prates <57069366+Lucas-Prates@users.noreply.github.com>
1 parent 2c9746f commit d95f70a

7 files changed

Lines changed: 109 additions & 100 deletions

File tree

‎.vscode/settings.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
"axhline",
3737
"axup",
3838
"axvline",
39+
"Barrowman",
3940
"behaviour",
4041
"bijective",
4142
"brentq",
@@ -65,11 +66,13 @@
6566
"cstride",
6667
"csys",
6768
"datapoints",
69+
"datetime",
6870
"ddot",
6971
"deletechars",
7072
"dimgrey",
7173
"discretizes",
7274
"disp",
75+
"Doretto",
7376
"dtype",
7477
"ECMWF",
7578
"edgecolor",
@@ -95,6 +98,7 @@
9598
"genfromtxt",
9699
"geopotential",
97100
"geopotentials",
101+
"Geospatial",
98102
"getdata",
99103
"getfixturevalue",
100104
"Giorgio",
@@ -103,14 +107,17 @@
103107
"Glauert",
104108
"gmaps",
105109
"Gomes",
110+
"Gonçalvez",
106111
"grav",
107112
"hemis",
108113
"hgtprs",
109114
"hgtsfc",
110115
"HIRESW",
116+
"HRES",
111117
"hspace",
112118
"ICONEU",
113119
"idxmax",
120+
"IGRA",
114121
"imageio",
115122
"imread",
116123
"intc",
@@ -121,7 +128,9 @@
121128
"isbijective",
122129
"isin",
123130
"jsonpickle",
131+
"Junqueira",
124132
"jupyter",
133+
"Kaleb",
125134
"Karman",
126135
"linalg",
127136
"linestyle",
@@ -130,14 +139,22 @@
130139
"LSODA",
131140
"lvhaack",
132141
"Mandioca",
142+
"Marte",
143+
"Masatoshi",
144+
"Mateus",
145+
"Matheus",
133146
"mathutils",
134147
"maxdepth",
135148
"mbar",
136149
"meshgrid",
150+
"Mesoscale",
151+
"Meteo",
152+
"Meteomatics",
137153
"Metrum",
138154
"mult",
139155
"Mumma",
140156
"NASADEM",
157+
"NCEP",
141158
"NDAP",
142159
"ndarray",
143160
"NDRT",
@@ -149,7 +166,9 @@
149166
"NOAA",
150167
"NOAA's",
151168
"noaaruc",
169+
"noaarucsounding",
152170
"num2pydate",
171+
"numpy",
153172
"outerboundaryis",
154173
"planform",
155174
"polystyle",
@@ -169,17 +188,21 @@
169188
"rwork",
170189
"savetxt",
171190
"savgol",
191+
"SBMT",
172192
"scilimits",
173193
"searchsorted",
174194
"seealso",
175195
"simplekml",
176196
"SIRGAS",
177197
"somgl",
178198
"Somigliana",
199+
"sqrd",
179200
"SRTM",
180201
"SRTMGL",
202+
"Stano",
181203
"subintervals",
182204
"ticklabel",
205+
"timedelta",
183206
"timezonefinder",
184207
"tmpprs",
185208
"toctree",
@@ -190,6 +213,7 @@
190213
"udot",
191214
"ufunc",
192215
"ugrdprs",
216+
"Unidimensional",
193217
"USGS",
194218
"uwyo",
195219
"vectorize",
@@ -198,6 +222,7 @@
198222
"vmax",
199223
"vmin",
200224
"vonkarman",
225+
"Wanderley",
201226
"Weibull",
202227
"windrose",
203228
"wireframe",

‎docs/user/environment/0-setup/elevation.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Elevation
22
=========
33

4-
The elevation of the launch site of a rocket is particularly important for
5-
determining its interaction with the atmosphere and Earth's gravitational field.
4+
The elevation of the launch site is particularly important for
5+
determining the rocket's interaction with the atmosphere and Earth's gravitational field.
66

7-
With previously known elevation
7+
Known elevation
88
-------------------------------
99

1010
If the elevation, measured in meters above sea level, along with the latitude

‎docs/user/environment/0-setup/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Setting Up the Environment
22
==========================
33

44
The first step is to set up the environment with the basic information.
5-
The date, time, location and elevation are the minimum requirements to start
5+
The date, time, location, and elevation are the minimum requirements to start
66
setting up the environment.
77

88
.. toctree::

‎docs/user/environment/1-atm-models/forecast.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ The same coordinates for SpacePort America will be used.
8585
.. jupyter-execute::
8686

8787
now = datetime.now()
88-
now_plus_six = now + timedelta(hours=12)
88+
now_plus_twelve = now + timedelta(hours=12)
8989

9090
env_rap = Environment(
9191
date=now_plus_six,

‎docs/user/environment/2-earth-models/topography.rst‎

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,34 +14,27 @@ as well as participation from the German and Italian space agencies.
1414
`NASA's Earth data Search <https://lpdaac.usgs.gov/products/nasadem_hgtv001/>`_.
1515

1616

17-
This is a first step forward stopping consider Earth as a constant plane better
18-
results when we are flying next to mountains or valleys
17+
Including the topography provides more accurate results when flying next to mountains or valleys.
1918

2019
Initialization
2120
--------------
2221

23-
First of all, we import the Environment class:
22+
Let us consider a fictional launch in Switzerland. First, we set the basic information about our Environment object
2423

2524
.. jupyter-execute::
2625

2726
from rocketpy import Environment
28-
29-
For example, let's set an Environment consider a fictional launch at Switzerland.
30-
First we need to set the basic information about our Environment object
31-
32-
.. jupyter-execute::
33-
3427
env = Environment(latitude=46.90479, longitude=8.07575, datum="WGS84")
3528

3629
.. note::
3730

38-
Notice that the datum argument is used only for the converting from geodesic \
39-
(i.e. lat/lon) to UTM coordinate system.
31+
The datum argument is used only for converting from geodesic \
32+
(i.e. lat/lon) to the UTM coordinate system.
4033

4134
Set the topographic profile
4235
---------------------------
4336

44-
Now we finally set our topography
37+
Now we set our topography
4538

4639
.. jupyter-execute::
4740

@@ -56,7 +49,7 @@ Now we finally set our topography
5649
Find the launch site elevation
5750
------------------------------
5851

59-
Once we defined the topographic profile, we can find the launch site elevation
52+
Once the topographic profile is defined, we can find the launch site elevation
6053

6154
.. jupyter-execute::
6255

@@ -72,8 +65,8 @@ And finally set the elevation to the Environment object:
7265
Visualize information
7366
---------------------
7467

75-
Now we can see the elevation that we have set, as well as other important
76-
attributes of our Environment object. We do that by running the
68+
To check the elevation we have set, as well as other important
69+
attributes of our Environment object, we run the
7770
:meth:`rocketpy.Environment.info` method:
7871

7972
.. jupyter-execute::

‎docs/user/environment/3-further/data_csv.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ or spreadsheet software. The file should have the following structure:
2626

2727
# Create a .csv file with the profiles
2828
data = {
29-
'height': [0, 1000, 2000, 3000, 4000],
29+
'height': [0, 1000, 2000, 3000, 4000], # m
3030
'pressure': [101325, 89876, 79508, 70122, 61653], # Pa
3131
'temperature': [288.15, 281.65, 275.15, 268.65, 262.15], # K
3232
'wind_u': [0, 1.0, 3, -0.5, -1], # m/s

0 commit comments

Comments
 (0)