diff --git a/README.md b/README.md index 0b56cb085def74a13abdd99f366def123fe7fb10..2b4427c9a156593d0e59c9c8b5cfacdc34667c5d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@  # msa-toolkit -The ***MSA toolkit*** is the repository in which the code implemented by the Mission Analysis team is stored. It is composed by several folders. <br/> -In order to properly run the msa toolkit code in matlab you will need to install the following matlab add-ons: +The ***MSA toolkit*** is the repository in which the code implemented by the Mission Analysis team is stored. It is composed of several folders. +In order to properly run the msa toolkit code in MATLAB, you will need to install the following MATLAB add-ons: * Aerospace Toolbox * Global Optimization Toolbox * Mapping Toolbox @@ -12,43 +12,60 @@ In order to properly run the msa toolkit code in matlab you will need to install * Statistics and Machine Learning Toolbox ### aerodynamicsOptimization -This program implements an aerodynamics optimization of the rocket. <br/> -The rocket is optimized to reach the highest apogee possible with the chosen set of fixed parameters. <br/> -The code uses a genetic algorithm to reach the goal. It may take some time to run. <br/> +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. + +**Example:** +```matlab +mainOptimization(rocket, wind, environment, settings); +``` ### apogeeAnalysis -This program is developed for a primary apogee -analysis with different engines when the structural mass -is only known with a degree of uncertainty. -The simulator computes the different apogees, maximum -accelerations and launchpad exit velocities for -different motors and different masses. +This program is developed for a primary apogee analysis with different engines when the structural mass is only known with a degree of uncertainty. The simulator computes the different apogees, maximum accelerations, and launchpad exit velocities for different motors and different masses. -### autoMatricesProtub -This program allows for an automatic computation of the rocket aerodynamic coefficients using Dissile MATCOM, for different airbrakes configuration. +**Example:** +```matlab +mainApogeeAnalysis(rocket, settings, analysis, plots); +``` -### commonFunctions -In this folder, the common functions employed in the code of the toolkit are stored. +### autoMatricesProtub +This program allows for an automatic computation of the rocket aerodynamic coefficients using Missile DATCOM, for different airbrakes configurations. -### data -Folder with the flight data, rocket geometry and simulation parameters. +**Example:** +```matlab +mainAutoMatProtub(rocket, environment, settings); +``` ### sensitivityAnalysis -This program implements a sensitivity analysis on the ascent phase of the rocket. Two types of analyses are available: deterministic and stochastic. <br/> -In the deterministic analysis it is possible to vary the nominal values of the aerodynamics coefficients and the structural mass of the rocket. -The relative magnitude of the variations is set by the user and it is the same for all the parameters considered in the analysis. <br/> -In the stochastic analysis several simulations are performed, in each of these the uncertain parameters assume values according to a normal distribution centered on their respective nominal values. +This program implements a sensitivity analysis on the ascent phase of the rocket. Two types of analyses are available: deterministic and stochastic. In the deterministic analysis, it is possible to vary the nominal values of the aerodynamics coefficients and the structural mass of the rocket. In the stochastic analysis, several simulations are performed, in each of these the uncertain parameters assume values according to a normal distribution centered on their respective nominal values. + +**Example:** +```matlab +mainSensitivity(rocket, wind, environment, settings, plots); +``` ### simulator -This is a program developed in MATLAB for the simulation of 6 D.o.F. rocket dynamics during all phases of flight: thrust, coast, apogee and recovery. <br/> -It predicts 3D trajectory, apogee height, forces acting on the rocket, and various other aerodynamic values. <br/> -This simulator can also run stochastic simulations with multiple options. <br/> +This is a program developed in MATLAB for the simulation of 6 D.o.F. rocket dynamics during all phases of flight: thrust, coast, apogee, and recovery. It predicts 3D trajectory, apogee height, forces acting on the rocket, and various other aerodynamic values. This simulator can also run stochastic simulations with multiple options. + +**Example:** +```matlab +mainSimulator(rocket, wind, environment, settings); +``` ### stabilityAnalysis This program is used to compute and investigate the stability of the rocket in various flight conditions. +**Example:** +```matlab +mainStabilityAnalysis(rocket, wind, environment, settings); +``` + ### unitTests This program is used to create and perform tests on the toolkit to ensure that it always produces correct results. +**Example:** +```matlab +results = runtests('mainUnitTests.m'); +``` + ### utils -Although the most important folders are in the main path, this folder contains work-alone tools, and some useful scripts. +Although the most important folders are in the main path, this folder contains standalone tools and some useful scripts.