Skip to content

Commit

Permalink
MAINT: add missing ® to MATLABs
Browse files Browse the repository at this point in the history
  • Loading branch information
giovaniceotto committed Mar 17, 2022
1 parent d4eb9af commit 3d41cd9
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -83,10 +83,10 @@ RocketPy is the next-generation trajectory simulation solution for High-Power Ro
</details>

<details>
<summary>Integration with MATLAB</summary>
<summary>Integration with MATLAB®</summary>
<ul>
<li>Straightforward way to run RocketPy from MATLAB</li>
<li>Convert RocketPy results to MATLAB variables so that they can be processed by MATLAB</li>
<li>Straightforward way to run RocketPy from MATLAB®</li>
<li>Convert RocketPy results to MATLAB® variables so that they can be processed by MATLAB®</li>
</ul>
</details>

Expand Down
22 changes: 11 additions & 11 deletions docs/matlab/Getting_Started.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/matlab/Getting_Started.m
Expand Up @@ -4,7 +4,7 @@
%
% We start by configuring the Python environment. You can do so by following
% the guidelines presented in the MATLAB® documentation: <https://www.mathworks.com/help/matlab/matlab_external/install-supported-python-implementation.html?searchHighlight=python&s_tid=srchtitle_python_4
% Configure Your System to Use Python - MATLAB & Simulink (mathworks.com)>.
% Configure Your System to Use Python - MATLAB® & Simulink (mathworks.com)>.
%
% Once the Python environment is configured, RocketPy needs to installed using
% |pip| as outlined in RocketPy's documentation: <https://docs.rocketpy.org/en/latest/user/installation.html#quick-install-using-pip
Expand All @@ -17,7 +17,7 @@
%%
% * Use some third-party libraries in the Python code that are not compatible
% with MATLAB®.
% * Isolate the MATLAB process from crashes in the Python code.
% * Isolate the MATLAB® process from crashes in the Python code.

pyenv('ExecutionMode','OutOfProcess');
%%
Expand Down Expand Up @@ -159,7 +159,7 @@
% attitude to decide when the parachute event should be triggered.
%
% Here, we define our trigger functions rather simply using Python. Unfortunately,
% defining these with MATLAB code is not yet possible.
% defining these with MATLAB® code is not yet possible.

% Drogue parachute is triggered when vertical velocity is negative, i.e. rocket is falling past apogee
drogueTrigger = py.eval("lambda p, y: y[5] < 0", py.dict);
Expand Down Expand Up @@ -218,7 +218,7 @@
%%
% Plots will open in a separate window, so be sure to run this last cell to
% seem them!
%% Working with Data Generated by RocketPy in MATLAB
%% Working with Data Generated by RocketPy in MATLAB®
% You can access the entire trajectory solution matrix with the following line
% of code. The returned matrix contain the following columns: time $t$ (s), $x$
% (m), $y$ (m), $z$ (m), $v_x$ (m/s), $v_y$ (m/s), $v_z$ (m/s), $q_0$, $q_1$,
Expand All @@ -231,7 +231,7 @@
% versions of RocketPy greater or equal to version 0.11.0.
%
% To showcase this, let's get the angle of attack of the rocket and plot it
% using MATLAB:
% using MATLAB®:

angle_of_attack = double(TestFlight.angleOfAttack.source)
plot(angle_of_attack(:,1), angle_of_attack(:,2)) % First column is time (s), second is the angle of attack
Expand All @@ -246,5 +246,5 @@
wind_velocity_x = double(Env.windVelocityX.source) % First column is altitude (ASL m), while the second one is the speed (m/s)
wind_velocity_y = double(Env.windVelocityY.source) % First column is altitude (ASL m), while the second one is the speed (m/s)
%% Time to Fly!
% This is all you need to get started using RocketPy in MATLAB! Now it is time
% This is all you need to get started using RocketPy in MATLAB®! Now it is time
% to play around and create amazing rockets. Have a great launch!
2 changes: 1 addition & 1 deletion rocketpy/Flight.py
Expand Up @@ -1109,7 +1109,7 @@ def __init__(
def __init_post_process_variables(self):
"""Initialize post-process variables."""
# Initialize all variables created during Flight.postProcess()
# Important to do so that MATLAB can access them
# Important to do so that MATLAB® can access them
self.windVelocityX = Function(0)
self.windVelocityY = Function(0)
self.density = Function(0)
Expand Down

0 comments on commit 3d41cd9

Please sign in to comment.