From c5270b33b2a9c5e4e83cfc2f4816a155c69e8cdf Mon Sep 17 00:00:00 2001 From: giuliaghirardini <giuliaghirardini2001@gmail.com> Date: Thu, 19 Dec 2024 11:31:19 +0100 Subject: [PATCH 1/9] [documentation] Updated README with new missions --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 722b350..8e25978 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,35 @@ # data This folder contains all the engines and the list of the rockets which are available within the repository. +## 2025_Orion_Portugal_October  +**Project name:** Orion <br /> +**Year of launch:** 2025 <br /> +**Location of Launch:** Pont de Sor (POR) <br /> +**Date of launch:** TBD <br /> +<br /><br /> + +## 2025_Orion_Roccaraso_September  +**Project name:** Orion <br /> +**Year of launch:** 2025 <br /> +**Location of Launch:** Roccaraso (ITA) <br /> +**Date of launch:** TBD <br /> +<br /><br /> + +## 2024_Lyra_Portugal_October +**Project name:** Lyra <br /> +**Year of launch:** 2024 <br /> +**Location of Launch:** Pont de Sor (POR) <br /> +**Date of launch:** TBD <br /> +<br /><br /> + +## 2024_Lyra_Roccaraso_September +**Project name:** Lyra <br /> +**Year of launch:** 2024 <br /> +**Location of Launch:** Roccaraso (ITA) <br /> +**Date of launch:** TBD <br /> +<br /><br /> -## Gemini_Portugal_October_2023  +## Gemini_Portugal_October_2023 **Project name:** Gemini <br /> **Year of launch:** 2023 <br /> **Location of Launch:** Pont de Sor (POR) <br /> @@ -10,7 +37,7 @@ This folder contains all the engines and the list of the rockets which are avail <br /><br /> -## Gemini_Roccaraso_September_2023  +## Gemini_Roccaraso_September_2023 **Project name:** Gemini <br /> **Year of launch:** 2023 <br /> **Location of Launch:** Roccaraso (ITA) <br /> -- GitLab From 16de2b8788199010a020fcfa6cc26d6422d614fe Mon Sep 17 00:00:00 2001 From: giuliaghirardini <giuliaghirardini2001@gmail.com> Date: Thu, 19 Dec 2024 11:35:39 +0100 Subject: [PATCH 2/9] [documentation] File clean up --- README.md | 223 +++++++++++++++++++++++++++++------------------------- 1 file changed, 122 insertions(+), 101 deletions(-) diff --git a/README.md b/README.md index 8e25978..1b20230 100644 --- a/README.md +++ b/README.md @@ -1,101 +1,122 @@ -# data -This folder contains all the engines and the list of the rockets which are available within the repository. - -## 2025_Orion_Portugal_October  -**Project name:** Orion <br /> -**Year of launch:** 2025 <br /> -**Location of Launch:** Pont de Sor (POR) <br /> -**Date of launch:** TBD <br /> -<br /><br /> - -## 2025_Orion_Roccaraso_September  -**Project name:** Orion <br /> -**Year of launch:** 2025 <br /> -**Location of Launch:** Roccaraso (ITA) <br /> -**Date of launch:** TBD <br /> -<br /><br /> - -## 2024_Lyra_Portugal_October -**Project name:** Lyra <br /> -**Year of launch:** 2024 <br /> -**Location of Launch:** Pont de Sor (POR) <br /> -**Date of launch:** TBD <br /> -<br /><br /> - -## 2024_Lyra_Roccaraso_September -**Project name:** Lyra <br /> -**Year of launch:** 2024 <br /> -**Location of Launch:** Roccaraso (ITA) <br /> -**Date of launch:** TBD <br /> -<br /><br /> - -## 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 /> - - -## 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 /> - - -## 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 /> - - -## 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 /> - - -## 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 /> - - - -## 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 /> - - -## 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 /> - - - -## 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 /> - - - -## 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 /> +# Data + +This folder contains all the engines and the list of rockets available within the repository. + +--- + +## 2025 Orion - Portugal (October) + + +- **Project Name:** Orion +- **Year of Launch:** 2025 +- **Location of Launch:** Pont de Sor (POR) +- **Date of Launch:** TBD + +--- + +## 2025 Orion - Roccaraso (September) + + +- **Project Name:** Orion +- **Year of Launch:** 2025 +- **Location of Launch:** Roccaraso (ITA) +- **Date of Launch:** TBD + +--- + +## 2024 Lyra - Portugal (October) + +- **Project Name:** Lyra +- **Year of Launch:** 2024 +- **Location of Launch:** Pont de Sor (POR) +- **Date of Launch:** TBD + +--- + +## 2024 Lyra - Roccaraso (September) + +- **Project Name:** Lyra +- **Year of Launch:** 2024 +- **Location of Launch:** Roccaraso (ITA) +- **Date of Launch:** TBD + +--- + +## 2023 Gemini - Portugal (October) + +- **Project Name:** Gemini +- **Year of Launch:** 2023 +- **Location of Launch:** Pont de Sor (POR) +- **Date of Launch:** TBD + +--- + +## 2023 Gemini - Roccaraso (September) + +- **Project Name:** Gemini +- **Year of Launch:** 2023 +- **Location of Launch:** Roccaraso (ITA) +- **Date of Launch:** TBD + +--- + +## 2022 Pyxis - Portugal (October) + +- **Project Name:** Pyxis +- **Year of Launch:** 2022 +- **Location of Launch:** Pont de Sor (POR) +- **Date of Launch:** 13/10/2022 + +--- + +## 2022 Pyxis - Roccaraso (September) + +- **Project Name:** Pyxis +- **Year of Launch:** 2022 +- **Location of Launch:** Roccaraso (ITA) +- **Date of Launch:** 17/09/2022 + +--- + +## 2021 Lynx - Portugal (October) + +- **Project Name:** Lynx +- **Year of Launch:** 2021 +- **Location of Launch:** Pont de Sor (POR) +- **Date of Launch:** 13/10/2021 + +--- + +## 2021 Lynx - Roccaraso (September) + +- **Project Name:** Lynx +- **Year of Launch:** 2021 +- **Location of Launch:** Roccaraso (ITA) +- **Date of Launch:** 18/09/2021 + +--- + +## 2019 Hermes V1 - Roccaraso (November) + +- **Project Name:** Hermes V1 +- **Year of Launch:** 2019 +- **Location of Launch:** Roccaraso (ITA) +- **Date of Launch:** 15/11/2019 + +--- + +## 2017 R2A - Sardinia (July) + +- **Project Name:** R2A +- **Year of Launch:** 2017 +- **Location of Launch:** Sardinia (ITA) +- **Date of Launch:** 07/2017 + +--- + +## 2014 R1X - Roccaraso (July) + +- **Project Name:** R1X +- **Year of Launch:** 2014 +- **Location of Launch:** Roccaraso (ITA) +- **Date of Launch:** 07/2014 -- GitLab From 608c9075ad44e385fe6030a902f0b1b804f7cb24 Mon Sep 17 00:00:00 2001 From: giuliaghirardini <giuliaghirardini2001@gmail.com> Date: Thu, 19 Dec 2024 11:47:55 +0100 Subject: [PATCH 3/9] [documentation] Reorganization in tables --- README.md | 135 +++++++++++++++--------------------------------------- 1 file changed, 38 insertions(+), 97 deletions(-) diff --git a/README.md b/README.md index 1b20230..e440154 100644 --- a/README.md +++ b/README.md @@ -1,122 +1,63 @@ # Data - -This folder contains all the engines and the list of rockets available within the repository. +Questo folder contiene tutti i motori e l'elenco dei razzi disponibili nel repository. --- -## 2025 Orion - Portugal (October) - - -- **Project Name:** Orion -- **Year of Launch:** 2025 -- **Location of Launch:** Pont de Sor (POR) -- **Date of Launch:** TBD +## 2025 +| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | +| ------------ | ------------------- | -------- | ------------------------------------------------------------- | +| Orion | Pont de Sor (POR) | TBD |  | +| Orion | Roccaraso (ITA) | TBD |  | --- -## 2025 Orion - Roccaraso (September) - - -- **Project Name:** Orion -- **Year of Launch:** 2025 -- **Location of Launch:** Roccaraso (ITA) -- **Date of Launch:** TBD +## 2024 +| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | +| ------------ | ------------------- | -------- | --------- | +| Lyra | Pont de Sor (POR) | TBD | | +| Lyra | Roccaraso (ITA) | TBD | | --- -## 2024 Lyra - Portugal (October) - -- **Project Name:** Lyra -- **Year of Launch:** 2024 -- **Location of Launch:** Pont de Sor (POR) -- **Date of Launch:** TBD +## 2023 +| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | +| ------------ | ------------------- | -------- | --------- | +| Gemini | Pont de Sor (POR) | TBD | | +| Gemini | Roccaraso (ITA) | TBD | | --- -## 2024 Lyra - Roccaraso (September) - -- **Project Name:** Lyra -- **Year of Launch:** 2024 -- **Location of Launch:** Roccaraso (ITA) -- **Date of Launch:** TBD +## 2022 +| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | +| ------------ | ------------------- | ---------- | --------- | +| Pyxis | Pont de Sor (POR) | 13/10/2022 | | +| Pyxis | Roccaraso (ITA) | 17/09/2022 | | --- -## 2023 Gemini - Portugal (October) - -- **Project Name:** Gemini -- **Year of Launch:** 2023 -- **Location of Launch:** Pont de Sor (POR) -- **Date of Launch:** TBD +## 2021 +| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | +| ------------ | ------------------- | ---------- | --------- | +| Lynx | Pont de Sor (POR) | 13/10/2021 | | +| Lynx | Roccaraso (ITA) | 18/09/2021 | | --- -## 2023 Gemini - Roccaraso (September) - -- **Project Name:** Gemini -- **Year of Launch:** 2023 -- **Location of Launch:** Roccaraso (ITA) -- **Date of Launch:** TBD +## 2019 +| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | +| ------------ | ------------------- | ---------- | --------- | +| HermesV1 | Roccaraso (ITA) | 15/11/2019 | | --- -## 2022 Pyxis - Portugal (October) - -- **Project Name:** Pyxis -- **Year of Launch:** 2022 -- **Location of Launch:** Pont de Sor (POR) -- **Date of Launch:** 13/10/2022 +## 2017 +| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | +| ------------ | ------------------- | -------- | --------- | +| R2A | Sardinia (ITA) | 07/2017 | | --- -## 2022 Pyxis - Roccaraso (September) - -- **Project Name:** Pyxis -- **Year of Launch:** 2022 -- **Location of Launch:** Roccaraso (ITA) -- **Date of Launch:** 17/09/2022 - ---- - -## 2021 Lynx - Portugal (October) - -- **Project Name:** Lynx -- **Year of Launch:** 2021 -- **Location of Launch:** Pont de Sor (POR) -- **Date of Launch:** 13/10/2021 - ---- - -## 2021 Lynx - Roccaraso (September) - -- **Project Name:** Lynx -- **Year of Launch:** 2021 -- **Location of Launch:** Roccaraso (ITA) -- **Date of Launch:** 18/09/2021 - ---- - -## 2019 Hermes V1 - Roccaraso (November) - -- **Project Name:** Hermes V1 -- **Year of Launch:** 2019 -- **Location of Launch:** Roccaraso (ITA) -- **Date of Launch:** 15/11/2019 - ---- - -## 2017 R2A - Sardinia (July) - -- **Project Name:** R2A -- **Year of Launch:** 2017 -- **Location of Launch:** Sardinia (ITA) -- **Date of Launch:** 07/2017 - ---- - -## 2014 R1X - Roccaraso (July) - -- **Project Name:** R1X -- **Year of Launch:** 2014 -- **Location of Launch:** Roccaraso (ITA) -- **Date of Launch:** 07/2014 +## 2014 +| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | +| ------------ | ------------------- | -------- | --------- | +| R1X | Roccaraso (ITA) | 07/2014 | | -- GitLab From 9a33a4bf782bb1e272fa3e18ba457b607d31dc97 Mon Sep 17 00:00:00 2001 From: giuliaghirardini <giuliaghirardini2001@gmail.com> Date: Thu, 19 Dec 2024 15:23:13 +0100 Subject: [PATCH 4/9] [documentation] Added cute badges --- README.md | 81 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 41 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index e440154..a85b1c2 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,64 @@ -# Data -Questo folder contiene tutti i motori e l'elenco dei razzi disponibili nel repository. +# Common ---- +This folder contains all the moters and the list of the rockets available in this submodule. -## 2025 -| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | -| ------------ | ------------------- | -------- | ------------------------------------------------------------- | -| Orion | Pont de Sor (POR) | TBD |  | -| Orion | Roccaraso (ITA) | TBD |  | +## Constellation programme +### 2025 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -------- | ------------------------------------------------------------ | +| Orion |    | Pont de Sor (POR) | TBD |  | +| Orion |    | Roccaraso (ITA) | TBD |  | --- -## 2024 -| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | -| ------------ | ------------------- | -------- | --------- | -| Lyra | Pont de Sor (POR) | TBD | | -| Lyra | 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 |  | --- -## 2023 -| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | -| ------------ | ------------------- | -------- | --------- | -| Gemini | Pont de Sor (POR) | TBD | | -| Gemini | Roccaraso (ITA) | TBD | | +### 2023 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ---------- | ---------------------------------------------------------- | +| Gemini |    | Pont de Sor (POR) | 17/10/2023 |  | +| Gemini |    | Roccaraso (ITA) | 19/09/2023 |  | --- -## 2022 -| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | -| ------------ | ------------------- | ---------- | --------- | -| Pyxis | Pont de Sor (POR) | 13/10/2022 | | -| Pyxis | Roccaraso (ITA) | 17/09/2022 | | +### 2022 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | ---------------------------------------------- | ----------------- | ---------- | ------------------------------------------------------------------ | +| Pyxis |  | Pont de Sor (POR) | 13/10/2022 |  | +| Pyxis |  | Roccaraso (ITA) | 17/09/2022 |  | --- -## 2021 -| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | -| ------------ | ------------------- | ---------- | --------- | -| Lynx | Pont de Sor (POR) | 13/10/2021 | | -| Lynx | Roccaraso (ITA) | 18/09/2021 | | +### 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 -| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | -| ------------ | ------------------- | ---------- | --------- | -| HermesV1 | Roccaraso (ITA) | 15/11/2019 | | +### 2019 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | --------------- | --------------- | ---------- | ---------- | +| HermesV1 | tbd | Roccaraso (ITA) | 15/11/2019 | | --- -## 2017 -| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | -| ------------ | ------------------- | -------- | --------- | -| R2A | Sardinia (ITA) | 07/2017 | | +### 2017 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | --------------- | --------------- | -------- | ---------- | +| R2A | tbd | Sardinia (ITA) | 07/2017 | | --- -## 2014 -| **Progetto** | **Luogo di Lancio** | **Data** | **Stato** | -| ------------ | ------------------- | -------- | --------- | -| R1X | Roccaraso (ITA) | 07/2014 | | +### 2014 +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | --------------- | --------------- | -------- | ---------- | +| R1X | tbd | Roccaraso (ITA) | 07/2014 | | -- GitLab From 5cb98bd70727b35bc99a9e875cb7762b46bea187 Mon Sep 17 00:00:00 2001 From: giuliaghirardini <giuliaghirardini2001@gmail.com> Date: Thu, 19 Dec 2024 21:03:38 +0100 Subject: [PATCH 5/9] [documentation] Resolved typos --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a85b1c2..b9c85dc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Common -This folder contains all the moters and the list of the rockets available in this submodule. +This folder contains all the motors and the list of the rockets available in this submodule. ## Constellation programme ### 2025 @@ -20,10 +20,10 @@ This folder contains all the moters and the list of the rockets available in thi --- ### 2023 -| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ---------- | ---------------------------------------------------------- | -| Gemini |    | Pont de Sor (POR) | 17/10/2023 |  | -| Gemini |    | Roccaraso (ITA) | 19/09/2023 |  | +| **Project** | **Engine type** | **Launch site** | **Date** | **Status** | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ---------- | ------------------------------------------------------------------ | +| Gemini |    | Pont de Sor (POR) | 17/10/2023 |  | +| Gemini |    | Roccaraso (ITA) | 19/09/2023 |  | --- -- GitLab From b48d2dad2407a98a4bb6a8a50a8b909da0f70432 Mon Sep 17 00:00:00 2001 From: giuliaghirardini <giulia.ghirardini@skywarder.eu> Date: Fri, 21 Feb 2025 21:54:51 +0100 Subject: [PATCH 6/9] [documentation] Added common definition and general usage --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b9c85dc..c217e93 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,51 @@ # Common -This folder contains all the motors and the list of the rockets available in this submodule. +Common is a **submodule** of msa-toolkit repository. + +A **submodule** is a separated 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` in which are stored all the common files, data and functions used among the departments. + +> [!WARNING] +> When working on main repo msa-toolkit be sure on what branch/commit is your submodule checked out. Data and results may be different on simulation if submodule is not updated to latest version! + + +## Submodule architecture + +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. +>[!CAUTION] +> 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 all the toolkits!. + +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 speficing the mission in `missionConfig.m`. + +```matlab +% YEAR_ROCKETNAME_LOCATION_MONTH +mission.name = '2025_Orion_Portugal_October'; +``` +Inside this folder you will find: + +* config: there are four files of config: + + * `environmentConfig.m`: it sets environmental variables for the launch and they are indipendent from the rocket itself (latitude, longitude, ...) + * `paraConfig.m`: configs for all parachutes onboard of both 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; the collect all the data which will be used by toolkits + +>[!NOTE] +> Classes were introduced during the 2024 refactoring of the toolkit! This new architecture enhances robustness, automation, and includes auto-generated documentation for classes. + +# Projects ## Constellation programme ### 2025 -- GitLab From 3cc9afb305fb62a06dedb0490baddc3e7e15cc0c Mon Sep 17 00:00:00 2001 From: giuliaghirardini <giulia.ghirardini@skywarder.eu> Date: Fri, 21 Feb 2025 21:59:50 +0100 Subject: [PATCH 7/9] [documentation] Triyng to resolve alert labels rendering on GitLab --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c217e93..c39950a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ For example, the main repo we are going to use is `msa-toolkit`. This repo has a > [!WARNING] > When working on main repo msa-toolkit be sure on what branch/commit is your submodule checked out. Data and results may be different on simulation if submodule is not updated to latest version! - +> ## Submodule architecture @@ -23,8 +23,10 @@ The submodule is divided into four main folders: mission.name = '2025_Orion_Portugal_October'; ``` * **settings**: this folder only contains `odeConfig.m`, which contains ODE settings. + >[!CAUTION] > 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 all the toolkits!. +> 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 speficing the mission in `missionConfig.m`. -- GitLab From c74d8d4227719f831ba3526aada7c8f63266f32c Mon Sep 17 00:00:00 2001 From: giuliaghirardini <giulia.ghirardini@skywarder.eu> Date: Fri, 21 Feb 2025 22:36:04 +0100 Subject: [PATCH 8/9] [documentation] GitLab Flavored Markdown (GLFM) does not support the [!ALERT] syntax. Used HTML instead --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c39950a..3ebc060 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,11 @@ A **submodule** is a separated repo, with its own commits and history, of your m For example, the main repo we are going to use is `msa-toolkit`. This repo has a submodule which is `common` in which are stored all the common files, data and functions used among the departments. -> [!WARNING] -> When working on main repo msa-toolkit be sure on what branch/commit is your submodule checked out. Data and results may be different on simulation if submodule is not updated to latest version! -> + +<div style="border-left: 4px solid #ffa500; padding: 10px;"> +<strong style="color: #ffa500;">âš Warning:</strong> When working on main repo msa-toolkit be sure on what branch/commit is your submodule checked out. Data and results may be different on simulation if submodule is not updated to latest version! +</div> + ## Submodule architecture @@ -23,10 +25,10 @@ The submodule is divided into four main folders: mission.name = '2025_Orion_Portugal_October'; ``` * **settings**: this folder only contains `odeConfig.m`, which contains ODE settings. - ->[!CAUTION] -> 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 all the toolkits!. -> + + +<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 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 speficing the mission in `missionConfig.m`. @@ -44,8 +46,9 @@ Inside this folder you will find: * `windConfig.m`: wind custom and wind matlab configs * data: all the `.mat` files are stored; the collect all the data which will be used by toolkits ->[!NOTE] -> Classes were introduced during the 2024 refactoring of the toolkit! This new architecture enhances robustness, automation, and includes auto-generated documentation for classes. +<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 -- GitLab From ec377c749f7cd86f9e9fc76616572188dd102060 Mon Sep 17 00:00:00 2001 From: giuliaghirardini <giulia.ghirardini@skywarder.eu> Date: Sat, 22 Feb 2025 12:25:29 +0100 Subject: [PATCH 9/9] [documentation] Resolved typos --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3ebc060..8aa555b 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ Common is a **submodule** of msa-toolkit repository. -A **submodule** is a separated 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. +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` in which are stored all the common files, data and functions used among the departments. +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. <div style="border-left: 4px solid #ffa500; padding: 10px;"> -<strong style="color: #ffa500;">âš Warning:</strong> When working on main repo msa-toolkit be sure on what branch/commit is your submodule checked out. Data and results may be different on simulation if submodule is not updated to latest version! +<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> @@ -27,10 +27,10 @@ The submodule is divided into four main folders: * **settings**: this folder only contains `odeConfig.m`, which contains ODE settings. -<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 all the toolkits!. +<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 speficing the mission in `missionConfig.m`. +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 @@ -40,11 +40,11 @@ Inside this folder you will find: * config: there are four files of config: - * `environmentConfig.m`: it sets environmental variables for the launch and they are indipendent from the rocket itself (latitude, longitude, ...) - * `paraConfig.m`: configs for all parachutes onboard of both main and parafoil + * `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; the collect all the data which will be used by toolkits +* data: all the `.mat` files are stored; they collect all the data which will be used by toolkits <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> -- GitLab