Skip to content

Commit 2defa9a

Browse files
Gui-FernandesBRGui-FernandesBR
authored
Merge pull request #633 from RocketPy-Team/dev/setting-up-vscode
DEV: setting up vscode workspace
2 parents 758f29d + 4de2918 commit 2defa9a

File tree

6 files changed

+252
-17
lines changed

6 files changed

+252
-17
lines changed

‎.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,9 +162,6 @@ cython_debug/
162162
*.docx
163163
*.pdf
164164

165-
# VSCode project settings
166-
.vscode/
167-
168165
# PyCharm
169166
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
170167
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore

‎.vscode/extensions.json

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"recommendations": [
3+
"ambooth.git-rename",
4+
"github.vscode-pull-request-github",
5+
"gruntfuggly.todo-tree",
6+
"mechatroner.rainbow-csv",
7+
"ms-python.black-formatter",
8+
"ms-python.debugpy",
9+
"ms-python.pylint",
10+
"ms-python.python",
11+
"ms-python.vscode-pylance",
12+
"ms-toolsai.jupyter",
13+
"ms-toolsai.jupyter-keymap",
14+
"ms-toolsai.jupyter-renderers",
15+
"ms-toolsai.vscode-jupyter-cell-tags",
16+
"ms-toolsai.vscode-jupyter-slideshow",
17+
"ms-vscode.cmake-tools",
18+
"ms-vscode.makefile-tools",
19+
"njpwerner.autodocstring",
20+
"streetsidesoftware.code-spell-checker",
21+
"trond-snekvik.simple-rst",
22+
]
23+
}

‎.vscode/settings.json

Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
{
2+
"python.testing.pytestArgs": [
3+
"tests"
4+
],
5+
"python.testing.unittestEnabled": false,
6+
"python.testing.pytestEnabled": true,
7+
"autoDocstring.docstringFormat": "numpy",
8+
"cSpell.enableFiletypes": [
9+
"python",
10+
"jupyter",
11+
"markdown",
12+
"restructuredtext"
13+
],
14+
"cSpell.language": "en-US",
15+
"cSpell.words": [
16+
"Abdulklech",
17+
"adjugate",
18+
"akima",
19+
"allclose",
20+
"altitudemode",
21+
"Alves",
22+
"amax",
23+
"arange",
24+
"arccos",
25+
"arcsin",
26+
"arctan",
27+
"argmax",
28+
"argmin",
29+
"argsort",
30+
"atol",
31+
"attrname",
32+
"autoclass",
33+
"autofetch",
34+
"autopep",
35+
"autouse",
36+
"axhline",
37+
"axup",
38+
"axvline",
39+
"behaviour",
40+
"bijective",
41+
"brentq",
42+
"Calebe",
43+
"calisto",
44+
"Calisto",
45+
"Cardano's",
46+
"cardanos",
47+
"carlo",
48+
"CDEFGHJKLMNPQRSTUVWXX",
49+
"Ceotto",
50+
"cesaroni",
51+
"Cesaroni",
52+
"cftime",
53+
"changealphaint",
54+
"Chassikos",
55+
"clabel",
56+
"clalpha",
57+
"cmap",
58+
"cmcens",
59+
"coeff",
60+
"coeffs",
61+
"colorbar",
62+
"colormaps",
63+
"contourf",
64+
"conusnest",
65+
"cstride",
66+
"csys",
67+
"datapoints",
68+
"ddot",
69+
"deletechars",
70+
"dimgrey",
71+
"discretizes",
72+
"disp",
73+
"dtype",
74+
"ECMWF",
75+
"edgecolor",
76+
"epsabs",
77+
"epsrel",
78+
"errstate",
79+
"evals",
80+
"exponentiated",
81+
"extrap",
82+
"facecolor",
83+
"fastapi",
84+
"Fernandes",
85+
"fftfreq",
86+
"figsize",
87+
"filt",
88+
"fmax",
89+
"fmin",
90+
"fontsize",
91+
"freestream",
92+
"funcified",
93+
"funcify",
94+
"GEFS",
95+
"genfromtxt",
96+
"geopotential",
97+
"geopotentials",
98+
"getdata",
99+
"getfixturevalue",
100+
"Giorgio",
101+
"Giovani",
102+
"github",
103+
"Glauert",
104+
"gmaps",
105+
"Gomes",
106+
"grav",
107+
"hemis",
108+
"hgtprs",
109+
"hgtsfc",
110+
"HIRESW",
111+
"hspace",
112+
"ICONEU",
113+
"idxmax",
114+
"imageio",
115+
"imread",
116+
"intc",
117+
"interp",
118+
"Interquartile",
119+
"intp",
120+
"ipywidgets",
121+
"isbijective",
122+
"isin",
123+
"jsonpickle",
124+
"jupyter",
125+
"Karman",
126+
"linalg",
127+
"linestyle",
128+
"linewidth",
129+
"loadtxt",
130+
"LSODA",
131+
"lvhaack",
132+
"Mandioca",
133+
"mathutils",
134+
"maxdepth",
135+
"mbar",
136+
"meshgrid",
137+
"Metrum",
138+
"mult",
139+
"Mumma",
140+
"NASADEM",
141+
"NDAP",
142+
"ndarray",
143+
"NDRT",
144+
"NETCDF",
145+
"newlinestring",
146+
"newmultigeometry",
147+
"newpolygon",
148+
"nfev",
149+
"NOAA",
150+
"NOAA's",
151+
"noaaruc",
152+
"num2pydate",
153+
"outerboundaryis",
154+
"planform",
155+
"polystyle",
156+
"powerseries",
157+
"Projeto",
158+
"prometheus",
159+
"pytz",
160+
"Rdot",
161+
"referece",
162+
"relativetoground",
163+
"reynolds",
164+
"ROABs",
165+
"rocketpy",
166+
"rstride",
167+
"rtol",
168+
"rucsoundings",
169+
"rwork",
170+
"savetxt",
171+
"savgol",
172+
"scilimits",
173+
"searchsorted",
174+
"seealso",
175+
"simplekml",
176+
"SIRGAS",
177+
"somgl",
178+
"Somigliana",
179+
"SRTM",
180+
"SRTMGL",
181+
"subintervals",
182+
"ticklabel",
183+
"timezonefinder",
184+
"tmpprs",
185+
"toctree",
186+
"trapz",
187+
"TRHEDDS",
188+
"triggerfunc",
189+
"twinx",
190+
"udot",
191+
"ufunc",
192+
"ugrdprs",
193+
"USGS",
194+
"uwyo",
195+
"vectorize",
196+
"vgrdprs",
197+
"viridis",
198+
"vmax",
199+
"vmin",
200+
"vonkarman",
201+
"Weibull",
202+
"windrose",
203+
"wireframe",
204+
"wspace",
205+
"xlabel",
206+
"xlim",
207+
"xticks",
208+
"ylabel",
209+
"ylim",
210+
"zdir",
211+
"zlabel",
212+
"zlim"
213+
]
214+
}

‎rocketpy/environment/environment.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ class Environment: # pylint: disable=too-many-public-methods
9595
True if the user already set a topographic profile. False otherwise.
9696
Environment.max_expected_height : float
9797
Maximum altitude in meters to keep weather data. The altitude must be
98-
above sea level (ASL). Especially useful for controlling plottings.
98+
above sea level (ASL). Especially useful for controlling plots.
9999
Can be altered as desired by doing `max_expected_height = number`.
100100
Environment.pressure_ISA : Function
101101
Air pressure in Pa as a function of altitude as defined by the
@@ -962,7 +962,7 @@ def set_atmospheric_model( # pylint: disable=too-many-branches
962962
963963
.. note::
964964
965-
Time referece for the Forecasts are:
965+
Time reference for the Forecasts are:
966966
967967
- ``GFS``: `Global` - 0.25deg resolution - Updates every 6
968968
hours, forecast for 81 points spaced by 3 hours

‎rocketpy/mathutils/function.py

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1191,7 +1191,7 @@ def plot(self, *args, **kwargs):
11911191
elif self.__dom_dim__ == 2:
11921192
self.plot_2d(*args, **kwargs)
11931193
else:
1194-
print("Error: Only functions with 1D or 2D domains are plottable!")
1194+
print("Error: Only functions with 1D or 2D domains can be plotted.")
11951195

11961196
def plot1D(self, *args, **kwargs):
11971197
"""Deprecated method, use Function.plot_1d instead."""
@@ -2614,8 +2614,8 @@ def isbijective(self):
26142614
return len(distinct_map) == len(x_data_distinct) == len(y_data_distinct)
26152615
else:
26162616
raise TypeError(
2617-
"Only Functions whose source is a list of points can be "
2618-
"checked for bijectivity."
2617+
"`isbijective()` method only supports Functions whose "
2618+
"source is an array."
26192619
)
26202620

26212621
def is_strictly_bijective(self):
@@ -2667,8 +2667,8 @@ def is_strictly_bijective(self):
26672667
return np.all(y_data_diff >= 0) or np.all(y_data_diff <= 0)
26682668
else:
26692669
raise TypeError(
2670-
"Only Functions whose source is a list of points can be "
2671-
"checked for bijectivity."
2670+
"`is_strictly_bijective()` method only supports Functions "
2671+
"whose source is an array."
26722672
)
26732673

26742674
def inverse_function(self, approx_func=None, tol=1e-4):
@@ -2678,8 +2678,9 @@ def inverse_function(self, approx_func=None, tol=1e-4):
26782678
and only if F is bijective. Makes the domain the range and the range
26792679
the domain.
26802680
2681-
If the Function is given by a list of points, its bijectivity is
2682-
checked and an error is raised if it is not bijective.
2681+
If the Function is given by a list of points, the method
2682+
`is_strictly_bijective()` is called and an error is raised if the
2683+
Function is not bijective.
26832684
If the Function is given by a function, its bijection is not
26842685
checked and may lead to inaccuracies outside of its bijective region.
26852686

‎rocketpy/simulation/monte_carlo.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -397,10 +397,10 @@ def __check_export_list(self, export_list):
397397
"lateral_surface_wind",
398398
}
399399
)
400-
# NOTE: exportables needs to be updated with Flight numerical properties
401-
# example: You added the property 'inclination' to Flight, so you may
402-
# need to add it to exportables as well. But don't add other types.
403-
exportables = set(
400+
# NOTE: this list needs to be updated with Flight numerical properties
401+
# example: You added the property 'inclination' to Flight.
402+
# But don't add other types.
403+
can_be_exported = set(
404404
{
405405
"inclination",
406406
"heading",
@@ -456,7 +456,7 @@ def __check_export_list(self, export_list):
456456
raise TypeError("Variables in export_list must be strings.")
457457

458458
# Checks if attribute is not valid
459-
if attr not in exportables:
459+
if attr not in can_be_exported:
460460
raise ValueError(
461461
f"Attribute '{attr}' can not be exported. Check export_list."
462462
)

0 commit comments

Comments
 (0)