Skip to content
Snippets Groups Projects
Commit eecd8b18 authored by Marco Luigi Gaibotti's avatar Marco Luigi Gaibotti
Browse files

[documentation] Updated main README

parent a3ffeaad
No related branches found
No related tags found
1 merge request!15Updated documentation for MSA Toolkit
......@@ -11,6 +11,8 @@ In order to properly run the msa toolkit code in MATLAB, you will need to instal
* Parallel Computing Toolbox
* Statistics and Machine Learning Toolbox
The repository itself contains the necessary tools, while the majority of the data is stored in the common folder, which is a submodule linked to the common repository
### aerodynamicsOptimization
This program implements an aerodynamics optimization of the rocket. The rocket is optimized to reach the highest apogee possible with the chosen set of fixed parameters using a genetic algorithm. It may take some time to run.
......@@ -24,7 +26,7 @@ This program is developed for a primary apogee analysis with different engines w
**Example:**
```matlab
mainApogeeAnalysis(rocket, settings, analysis, plots);
[standardResults, engineCutResults] = mainApogeeAnalysis(rocket, settings, analysis, plots);
```
### autoMatricesProtub
......@@ -32,7 +34,7 @@ This program allows for an automatic computation of the rocket aerodynamic coeff
**Example:**
```matlab
mainAutoMatProtub(rocket, environment, settings);
[coeffsTot, coeffsTotHighAOA] = mainAutoMatProtub(rocket, environment, settings);
```
### sensitivityAnalysis
......@@ -40,7 +42,7 @@ This program implements a sensitivity analysis on the ascent phase of the rocket
**Example:**
```matlab
mainSensitivity(rocket, wind, environment, settings, plots);
[postProcess, parameters] = mainSensitivity(rocket, wind, environment, settings, plots);
```
### simulator
......@@ -48,7 +50,7 @@ This is a program developed in MATLAB for the simulation of 6 D.o.F. rocket dyna
**Example:**
```matlab
mainSimulator(rocket, wind, environment, settings);
[ascent, descent] = mainSimulator(rocket, wind, environment, settings);
```
### stabilityAnalysis
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment