Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Generic Surface #690

Merged
merged 11 commits into from
Sep 14, 2024
Merged

DOC: Generic Surface #690

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7c801ce
MNT: refactoring coefficients argument on __init__
Lucas-Prates Sep 13, 2024
11e6777
MNT: cleaning input arguments from compute_forces_and_moments method
Lucas-Prates Sep 13, 2024
3b20605
DOC: adapting notebook to the new signature of general_surfaces
Lucas-Prates Sep 13, 2024
6807300
MNT: removing unnecessary pylint flags and fixing small errors
Lucas-Prates Sep 13, 2024
2a700ca
DOC: add reference to docs
MateusStano Sep 13, 2024
76e137c
DOC: add generic surface doc page
MateusStano Sep 14, 2024
b6ff979
DOC: mention docs on classes init
MateusStano Sep 14, 2024
9016cce
DOC: address all review comments
MateusStano Sep 14, 2024
9459360
DOC: typo
MateusStano Sep 14, 2024
2e4d34b
ENH: remove add_generic_surface
MateusStano Sep 14, 2024
78fb46c
Merge branch 'enh/generic-surfaces' into doc/generic-surface
MateusStano Sep 14, 2024
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
22 changes: 14 additions & 8 deletions docs/notebooks/coeff_testing.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,25 +458,31 @@
"gennose = GenericSurface(\n",
" reference_area=np.pi * calisto.radius**2,\n",
" reference_length=2 * calisto.radius,\n",
" cL=\"nose_cL.csv\",\n",
" cQ=\"nose_cQ.csv\",\n",
" coefficients={\n",
" \"cL\": \"nose_cL.csv\",\n",
" \"cQ\": \"nose_cQ.csv\",\n",
" },\n",
" center_of_pressure=(0, 0, 0),\n",
" name=\"nose\",\n",
")\n",
"genfin = GenericSurface(\n",
" reference_area=np.pi * calisto.radius**2,\n",
" reference_length=2 * calisto.radius,\n",
" cL=\"fins_cL.csv\",\n",
" cQ=\"fins_cQ.csv\",\n",
" cl=\"fins_roll.csv\",\n",
" coefficients={\n",
" \"cL\": \"fins_cL.csv\",\n",
" \"cQ\": \"fins_cQ.csv\",\n",
" \"cl\": \"fins_roll.csv\",\n",
" },\n",
" center_of_pressure=(0, 0, 0),\n",
" name=\"fins\",\n",
")\n",
"gentail = GenericSurface(\n",
" reference_area=np.pi * calisto.radius**2,\n",
" reference_length=2 * calisto.radius,\n",
" cL=\"tail_cL.csv\",\n",
" cQ=\"tail_cQ.csv\",\n",
" coefficients={\n",
" \"cL\": \"tail_cL.csv\",\n",
" \"cQ\": \"tail_cQ.csv\",\n",
" },\n",
" center_of_pressure=(0, 0, 0),\n",
" name=\"tail\",\n",
")\n",
Expand Down Expand Up @@ -2451,7 +2457,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.0"
"version": "3.11.2"
},
"vscode": {
"interpreter": {
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/classes/aero_surfaces/GenericSurface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Generic Surface Class
---------------------

.. autoclass:: rocketpy.GenericSurface
:members:
5 changes: 5 additions & 0 deletions docs/reference/classes/aero_surfaces/LinearGenericSurface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Linear Generic Surface Class
----------------------------

.. autoclass:: rocketpy.LinearGenericSurface
:members:
2 changes: 2 additions & 0 deletions docs/reference/classes/aero_surfaces/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ AeroSurface Classes
EllipticalFins
RailButtons
AirBrakes
GenericSurface
LinearGenericSurface
Binary file added docs/static/rocket/aeroframe.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/user/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ RocketPy's User Guide
Positions and Coordinate Systems <positions.rst>
Motors <motors/motors.rst>
Rocket <rocket/rocket.rst>
Environment <environment.rst>

.. toctree::
:maxdepth: 2
Expand Down
Loading