diff --git a/README.md b/README.md index 722b350741149ea19998590a3d590a43b5915abb..8aa555baa164103b0f8787403798b9c60d3ed8ff 100644 --- a/README.md +++ b/README.md @@ -1,74 +1,114 @@ -# data -This folder contains all the engines and the list of the rockets which are available within the repository. +# Common +Common is a **submodule** of msa-toolkit repository. -## Gemini_Portugal_October_2023  -**Project name:** Gemini <br /> -**Year of launch:** 2023 <br /> -**Location of Launch:** Pont de Sor (POR) <br /> -**Date of launch:** TBD <br /> -<br /><br /> +A **submodule** is a separate repo, with its own commits and history, of your main project. It is shown as a subdirectory of the main repo, but technically is not just a subdirectory. This is due to the fact that the submodule and the repo are treated separately. +For example, the main repo we are going to use is `msa-toolkit`. This repo has a submodule which is `common` where all the common files, data, and functions are stored. -## Gemini_Roccaraso_September_2023  -**Project name:** Gemini <br /> -**Year of launch:** 2023 <br /> -**Location of Launch:** Roccaraso (ITA) <br /> -**Date of launch:** TBD <br /> -<br /><br /> +<div style="border-left: 4px solid #ffa500; padding: 10px;"> +<strong style="color: #ffa500;">âš Warning:</strong> When working on main repo msa-toolkit be sure which branch/commit your submodule is checked out on. Data and results may be different in simulation if submodule is not updated to latest version! +</div> -## Pyxis_Portugal_October_2022 -**Project name:** Pyxis <br /> -**Year of launch:** 2022 <br /> -**Location of Launch:** Pont de Sor (POR) <br /> -**Date of launch:** 13/10/2022 <br /> -<br /><br /> +## Submodule architecture -## Pyxis_Roccaraso_September_2022 -**Project name:** Pyxis <br /> -**Year of launch:** 2022 <br /> -**Location of Launch:** Roccaraso (ITA) <br /> -**Date of launch:** 17/09/2022 <br /> -<br /><br /> +The submodule is divided into four main folders: + + * **classes**: in this folder you can find the classes over which are defined methods and variables. They are the "kernel" of the toolkit. + * **functions**: here you can find all the functions to make msa toolkits working; there are plenty of functions, from ode functions to functions which generates standardized plots for reports. + * **missions**: here all the missions together with all data are stored. By opening `missionConfig.m` you can choose the mission. + + ```matlab + mission = Mission(); + mission.name = '2025_Orion_Portugal_October'; + ``` + * **settings**: this folder only contains `odeConfig.m`, which contains ODE settings. -## Lynx_Portugal_October_2021 -**Project name:** Lynx <br /> -**Year of launch:** 2021 <br /> -**Location of Launch:** Pont de Sor (POR) <br /> -**Date of launch:** 13/10/2021 <br /> -<br /><br /> +<div style="border-left: 4px solid rgb(229, 77, 92); padding: 10px;"><strong style="color:rgb(229, 77, 92)">! Caution:</strong> Don't touch `odeConfig.m` if you don't know what you're doing, from this configuration file depend ODE-based script, such ad `ballistic.m`, and so do all the toolkits!. +</div> +Inside the mission folder, you can find all the missions and their data and configurations file. Each folder has the name of the mission in a specific format/order. This format is the one you have to use when specifying the mission in `missionConfig.m`. +```matlab +% YEAR_ROCKETNAME_LOCATION_MONTH +mission.name = '2025_Orion_Portugal_October'; +``` +Inside this folder you will find: -## Lynx_Roccaraso_September_2021 -**Project name:** Lynx <br /> -**Year of launch:** 2021 <br /> -**Location of Launch:** Roccaraso (ITA) <br /> -**Date of launch:** 18/09/2021 <br /> -<br /><br /> +* config: there are four files of config: + * `environmentConfig.m`: it sets environmental variables for the launch and they are independent from the rocket itself (latitude, longitude, ...) + * `paraConfig.m`: configs for all parachutes onboard, including both the main and parafoil + * `rocketConfig.m`: general parameters of the rocket divided for each bay (nose, parafoil, recovery, ...) + * `windConfig.m`: wind custom and wind matlab configs +* data: all the `.mat` files are stored; they collect all the data which will be used by toolkits -## HermesV1_Roccaraso_November_2019 -**Project name:** Lynx <br /> -**Year of launch:** 2019 <br /> -**Location of Launch:** Roccaraso (ITA) <br /> -**Date of launch:** 15/11/2019 <br /> <br /> <br /> <br /> +<div style="border-left: 4px solid rgb(30, 139, 255); padding: 10px;"><strong style="color:rgb(30, 139, 255)">â„¹ï¸ Note:</strong> Classes were introduced during the 2024 refactoring of the toolkit! This new architecture enhances robustness, automation, and includes auto-generated documentation for classes. +</div> +# Projects -## R2A_Sardinia_July_2017 -**Project name:** R2A <br /> -**Year of launch:** 2017 <br /> -**Location of Launch:** Sardinia (ITA) <br /> -**Date of launch:** 07/2017 <br /> <br /> <br /> <br /> +## Constellation programme +### 2025 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -------- | ------------------------------------------------------------ | +| Orion |    | Pont de Sor (POR) | TBD |  | +| Orion |    | Roccaraso (ITA) | TBD |  | +--- +### 2024 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ---------- | ------------------------------------------------------------------ | +| Lyra |    | Pont de Sor (POR) | 12/10/2024 |  | +| Lyra |    | Roccaraso (ITA) | 14/09/2024 |  | -## R1X_Roccaraso_July_2014 -**Project name:** R1X <br /> -**Year of launch:** 2014 <br /> -**Location of Launch:** Roccaraso (ITA) <br /> -**Date of launch:** 07/2014 <br /> <br /> <br /> <br /> +--- + +### 2023 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ---------- | ------------------------------------------------------------------ | +| Gemini |    | Pont de Sor (POR) | 17/10/2023 |  | +| Gemini |    | Roccaraso (ITA) | 19/09/2023 |  | + +--- + +### 2022 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | ---------------------------------------------- | ----------------- | ---------- | ------------------------------------------------------------------ | +| Pyxis |  | Pont de Sor (POR) | 13/10/2022 |  | +| Pyxis |  | Roccaraso (ITA) | 17/09/2022 |  | + +--- + +### 2021 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | ---------------------------------------------- | ----------------- | ---------- | ------------------------------------------------------------------ | +| Lynx |  | Pont de Sor (POR) | 13/10/2021 |  | +| Lynx |  | Roccaraso (ITA) | 18/09/2021 |  | + +--- +## Previous projects + +### 2019 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | --------------- | --------------- | ---------- | ---------- | +| HermesV1 | tbd | Roccaraso (ITA) | 15/11/2019 | | + +--- + +### 2017 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | --------------- | --------------- | -------- | ---------- | +| R2A | tbd | Sardinia (ITA) | 07/2017 | | + +--- + +### 2014 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | --------------- | --------------- | -------- | ---------- | +| R1X | tbd | Roccaraso (ITA) | 07/2014 | |