diff --git a/docs/documentation/analysis/mission_analysis/getting_started.md b/docs/documentation/analysis/mission_analysis/getting_started.md index fb08b4ae45800f88b417e5e9baad5ad9618086d4..db54daa790b9087e3546c065ce5cbdf193d2df48 100644 --- a/docs/documentation/analysis/mission_analysis/getting_started.md +++ b/docs/documentation/analysis/mission_analysis/getting_started.md @@ -358,7 +358,7 @@ Beside being a neat dataset to show-off, [Ecological Assessment](../ecological_a ### Reporting -If you don't want to edit your data on your own, but need to see some basic characteristics of your mission, you can simply go to the `reporting` directory next to your [Aircraft Exchange File](#acxml). Within `report_html`, we already provide many graphs and useful insights which might come in handy. If something went wrong or you need to know what **mission_analysis** has done in detail, there is also a `log_files` folder in which the shell output is tracked. +If you don't want to edit your data on your own, but need to see some basic characteristics of your mission, you can simply go to the `reporting` directory next to your [Aircraft Exchange File](#acxml). Within `report_html`, we already provide many graphs and useful insights which might come in handy. If something went wrong or you need to know what **mission_analysis** has done in detail, there is also a `.log` file next to your executable in which the shell output is tracked. ## Mission Configuration {#configuration} diff --git a/docs/documentation/analysis/mission_analysis/index.md b/docs/documentation/analysis/mission_analysis/index.md index f9ad12796317779b31d6465c66bdd9d29a3262f3..8fad77ed00dd8ef6bb6fe5fe86f014dd27280a47 100644 --- a/docs/documentation/analysis/mission_analysis/index.md +++ b/docs/documentation/analysis/mission_analysis/index.md @@ -29,8 +29,6 @@ Once your mission is calculated, you can choose from a wide range of profile dat ## Quick Overview -By now, only a [standard (3D) mission method](methods.md/#midfi) is implemented. Its mid-fidelity version can trigger the three missions mentioned above while the low-fidelity sub-version is only used for the `design_mission`. The later is a Breguet-based estimation of the consumed mission fuel and it is triggered automatically if no initial values where given for the `design_mission`. A 4D trajectory mission is also planned, but it is still in the making. - | Mission method | mission type | Status | |----------------------------------|---------------------------|----------------------------------------| | [3D Standard Mission (low-fidelity)](methods.md/#midfi)|`design_mission::breguet`| running :white_check_mark:| @@ -39,6 +37,22 @@ By now, only a [standard (3D) mission method](methods.md/#midfi) is implemented. | [3D Standard Mission (mid-fidelity)](methods.md/#midfi)|`requirements_mission` | running :white_check_mark:| | [4D_trajectory (high-fidelity)](methods.md/#highfi) |None | under development :construction:| +By now, only a [standard (3D) mission method](methods.md/#midfi) is implemented. Its mid-fidelity version can trigger the three missions mentioned above while the low-fidelity sub-version is only used for the `design_mission`. The later is a Breguet-based estimation of the consumed mission fuel and it is triggered automatically if no initial values where given for the `design_mission`. A 4D trajectory mission is also planned, but it is still in the making. + +<pre class='mermaid'> + graph TD; + A[mission_analysis]-->B[design_mission] + B-->E[low-fidelity] + B-->F[mid-fidelity] + B-->G["(high-fidelity)"] + A-->C[study_mission] + C-->H[mid-fidelity] + C-->I["(high-fidelity)"] + A-->D[requirements_mission] + D-->J[mid-fidelity] + D-->K["(high-fidelity)"] +</pre> + ## Where to start diff --git a/mkdocs.yml b/mkdocs.yml index 73d15432f42d2695045048a48949222fd4acdb52..a21c7bd94ef6980ab6e112791e27410f5f5be9d2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -293,6 +293,11 @@ nav: # Customizes the main navigation struc - Getting Started: documentation/analysis/mission_analysis/getting_started.md - Mission Methods: documentation/analysis/mission_analysis/methods.md - Mission Steps: documentation/analysis/mission_analysis/mission_steps.md + - API Reference: + - mission_analysis/classes.md + - mission_analysis/namespaces.md + - mission_analysis/files.md + - mission_analysis/functions.md - Weight and Balance Analysis: - Introduction: documentation/analysis/weight_and_balance_analysis/index.md - Basic Concepts: documentation/analysis/weight_and_balance_analysis/basic-concepts.md