From 478d90c6efc25fbd67d84c1143d423e9e51eb2e3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9CKatrinBistreck=E2=80=9D?=
<“katrin.bistreck@tuhh.de”>
Date: Thu, 30 Jan 2025 17:50:04 +0100
Subject: [PATCH 1/4] new structure; including first basic concepts + usage
---
.../ecological_assessment/aqi_schaefer.md | 69 --
.../ecological_assessment/basic-concepts.md | 677 +++++++++++++++
.../climate_model_dallara.md | 214 -----
.../ecological_assessment/getting-started.md | 32 -
.../analysis/ecological_assessment/index.md | 39 +-
.../ecological_assessment/lca_schaefer.md | 815 ------------------
.../ecological_assessment/literature.bib | 134 ++-
.../mission_emissions.md | 194 -----
...chitecture.md => software-architecture.md} | 0
.../analysis/ecological_assessment/usage.md | 137 +++
mkdocs.yml | 24 +-
11 files changed, 926 insertions(+), 1409 deletions(-)
delete mode 100644 docs/documentation/analysis/ecological_assessment/aqi_schaefer.md
create mode 100644 docs/documentation/analysis/ecological_assessment/basic-concepts.md
delete mode 100644 docs/documentation/analysis/ecological_assessment/climate_model_dallara.md
delete mode 100644 docs/documentation/analysis/ecological_assessment/getting-started.md
delete mode 100644 docs/documentation/analysis/ecological_assessment/lca_schaefer.md
delete mode 100644 docs/documentation/analysis/ecological_assessment/mission_emissions.md
rename docs/documentation/analysis/ecological_assessment/{softwarearchitecture.md => software-architecture.md} (100%)
create mode 100644 docs/documentation/analysis/ecological_assessment/usage.md
diff --git a/docs/documentation/analysis/ecological_assessment/aqi_schaefer.md b/docs/documentation/analysis/ecological_assessment/aqi_schaefer.md
deleted file mode 100644
index 9d53720..0000000
--- a/docs/documentation/analysis/ecological_assessment/aqi_schaefer.md
+++ /dev/null
@@ -1,69 +0,0 @@
-# air_quality_index_schaefer {#aqi-schaefer}
-This method provides a single indicator (called the Air Quality Index (AQI)) for the assessment of air quality. The AQI can take values between 0 and 1, with 1 indicating that the allowable limits defined by ICAO are reached by all species. Therefore, low values are preferable.
-
-## General principles {#aqi-schaefer-generalprinciples}
-The calculation method, including all required inputs, is described in Schaefer (2017) \cite Sch17. It is:
-
-$ AQI = 1/n \cdot \sum x_i/x_{i,max}$
-
-where:
-
-- $ x_i $: emission mass [g] ( for CO, HC, NOx) or maximum concentration [mg/m^3] ( for soot) during the landing and takeoff cycle,
-- $ x_{i,max}$: regulatory value defined by ICAO, the ratio of emission mass Dp [g] emitted during LTO and the rated thrust F00 [kN],
-- $ n $: number of emission species.
-
-## Input-Data {#aqi-schaefer-input}
-Only engine and emission data are needed. To construct the engine object, the following is required from acXML:
-```xml
-<engine description="Description of engine">
- <engine_model description="Name of selected engine model">
- <value>V2527-A5</value>
- </engine_model>
- <scale_factor description="Scale factor">
- <value>1.168175939</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>5</upper_boundary>
- </scale_factor>
-</engine>
-```
-
-From `ecological_assessment_results` following parameter will be read:
-```xml
-<calculation_results description="Results of calculation method">
- <mission_emissions description="Results of mission emission calculation">
- <study_mission description="Results of study mission calculation">
- <emissions description="Emissions of study mission">
- <LTO_cycle description="Emissions of landing and takeoff cycle">
- <HC description="LTO HC emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </HC>
- <CO description="LTO CO emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CO>
- <NOx description="LTO NOx emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </NOx>
- <c_soot_LTO_max description="Maximum soot concentration during study mission LTO">
- <value>0</value>
- <unit>1</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </c_soot_LTO_max>
- </LTO_cycle>
- </emissions>
- </study_mission>
- </mission_emissions>
-</calculation_results>
-```
-## Output-Data {#aqi-schaefer-output}
-The submodule writes its calculation results into the HTML report located in `aircraft_exchange_file_directory/reporting/reportHTML`.
\ No newline at end of file
diff --git a/docs/documentation/analysis/ecological_assessment/basic-concepts.md b/docs/documentation/analysis/ecological_assessment/basic-concepts.md
new file mode 100644
index 0000000..d5e6424
--- /dev/null
+++ b/docs/documentation/analysis/ecological_assessment/basic-concepts.md
@@ -0,0 +1,677 @@
+# Basic concepts {#basic-concepts}
+This chapter provides some insight in the implemented calculation routines. The module is split into several submodules which are responsible to calculate parts of the ecological assessment. The following graph shows a rough overview of the module structure, with the end points standing for a submodule:
+<pre class='mermaid'>
+ graph TD;
+ A[ecological_assessment/src]-->C[standard_strategy]
+ C-->D[emission_calculation]
+ D-->F[life_cycle_emissions]
+ F-->H[LCA_schaefer]
+ D-->G[mission_emissions]
+ C-->E[impact_calculation]
+ E-->I[air_quality_index_schaefer]
+ E-->J[climate_impact_dallara]
+</pre>
+
+The next sections will describe the submodules in detail, with information about in- and outputs as well as calculation routines. If you'd like to get more information about the values named in the input xml files, you can have an look into the files and read the corresponding description.
+
+## Mission Emissions {#mission-emissions}
+The submodule _mission_emissions_ is the only part of _ecological\_assessment_ which can not be deactivated by the user, as its results are needed by all other submodules. It provides various options to calculate the emissions of kerosene or hydrogen-burning engines during a mission. Both the design and the study mission will be calculated (in the following, file names including *mission* will always mean *study_mission* and *design_mission*).
+
+### General principles {#mission-emissions-generalprinciples}
+Depending on the defined engine carrier, the emissions will be calculated for every mission step defined in the `mission.csv` file. Only pure kerosene or pure liquid hydrogen combustion is possible, other energy carriers or hybrid variants are not implemented and will lead to a program abortion!
+
+The needed engine thermodynamics during the landing and takeoff phase (LTO) according to ICAO definition are calculated by the engine library. If you're interested in seeing a comparison between the standard ICAO LTO cycle and your aircraft design, you need to switch on the `info` mode for console or log file output inside your configuration file to get those information. Following thrust settings in percent of take-off thrust are used for LTO:
+
+Taxiing | Take-off | Climb | Approach |
+--------|----------|-------|----------|
+7% |100% |85% |30% |
+
+If the taxiing thrust can not be set (which happens sometimes because of a lack of engine data), you will see a warning and the engine will automatically set to idle conditions.
+
+Then, the main task of this submodule is executed: the emission calculation.
+
+#### Kerosene Emissions
+Kerosene combustion emissions will be calculated as following:
+
+The emissions of CO2, H2O, SO2, SO4 and (in a low fidelity approach) soot are considered to be proportional to the fuel flow. Therefore, they are calculated via
+
+$ m_{emission} = EI * m_{fuel}$,
+
+with
+
+- $ m_{emission}$: emission mass $[kg]$
+- $ EI $: emission index $[\frac{kg_{emission}}{kg_{fuel}}]$
+- $ m_{fuel} $: fuel mass $[kg]$
+
+Following emission indices are used:
+
+Emission | EI [kg/kg] |
+---------|------------|
+CO2 | 3.149 |
+H2O | 1.2 |
+SO2 | 0.84e-3 |
+SO4 | 2e-4 |
+Soot | 0.025e-3 |
+
+All other emissions are considered to be non-proportional and are calculated with following methods:
+
+- For NOx emissions, there are a P3T3 Method \cite Nor03, Boeing Fuel Flow Method 2 \cite Sch13, and the calculation based on data generated by GasTurb available.
+- For HC as well as CO emissions, the DLR Omega method and Boeing Fuel Flow Method 2 \cite Sch13 are implemented. Additionally, there is the option to calculate the landing and takeoff cycle emissions based on constants provided by ICAO.
+- Soot emissions can be determined via a DLR correlation based on ICAO smoke numbers or a correlation by R.B. Whyte \cite Kug05. Alternatively, it can be assumed to be proportional to the consumed fuel.
+
+#### Hydrogen Combustion Emissions
+When hydrogen is burned in a engine, only H2O and NOx emissions are produced. H2O is again assumed to be proportional to the fuel flow. For NOx emissions, the emissions of kerosene-burning engines are calculated via the P3T3 method and a correction factor is used to derive the hydrogen-burning emissions \cite Koss22. You can choose between the calculation of the correction factor and the use of constant emission indices, which were determined in \cite Koss22 for one engine type. As the determination of NOx emissions when burning hydrogen is subject to great uncertainty, the low-fidelity method of using constants is both used as the default method and also implemented as a fallback method if the calculation of a correction factor fails. Following constant NOx emission indices are used:
+
+Phase | EI [g/kg]|
+--------|----------|
+Taxi | 1.1 |
+Takeoff | 8.02 |
+Climb | 6.17 |
+Cruise | 3.14 |
+Approach| 2.4 |
+
+
+### Input data {#mission-emissions-input}
+For the mission emission calculation (including used libraries), the following parameters are needed in the `aircraft_exchange_file`:
+```xml
+- requirements_and_specifications
+ - general
+ - type
+ - model
+ - design_specification
+ - configuration
+ - configuration_type
+ - aerodynamic_technologies
+ - energy_carriers
+ - energy_carrier (ID="0")
+ - type
+ - assessment_scenario
+ - flights_per_year
+```
+
+In the `ecological_assessment_conf.xml`, next to the control settings block, you can set the emission calculation methods, relative humidity of the air and the duration of aircraft operation within the program settings:
+```xml
+- strategy_selector
+ - standard_strategy
+ - emission_calculation
+ - mission_emissions
+ - emission_methods
+ - kerosene
+ - HC_method_selector
+ - CO_method_selector
+ - NOx_method_selector
+ - soot_method_selector
+ - hydrogen_combustion
+ - NOx_method_selector
+ - relative_humidity
+ - duration_operation
+```
+
+From `mission.xml`, the taxi time and range will be read :
+```xml
+- taxi_time_origin
+- taxi_time_destination
+- range
+```
+Additionally, you need to provide the `mission.csv` file written by the UNICADO *mission_analysis* module and located in _aircraft\_exchange\_file\_directory/mission_data_.
+
+And last but not least, the engine library will be used, so you can check the documentation page of the library to get information about its input files.
+
+### Output data {#mission-emissions-output}
+The central output of the mission submodule is the `ecological_assessment_results_file.xml` which you will find in the *aircraft\_exchange\_file\_directory/reporting/report_xml* directory. It contains all calculated emission masses. Additionally, there is a `...emissionspath.csv` file in the folder *aircraft_exchange_file_directory/mission_data/* including mission and engine data for every mission step. As described in [Module usage](#usage), an HTML report including plots with emission flows will be generated.
+
+
+## LCA Schaefer {#lca-schaefer}
+The method is based on the dissertation by Katharina Schäfer (2011) \cite Sch17. It is highly recommended to refer to this work for detailed insights. The method calculates the energy demand and emissions across the aircraft's life cycle phases: development, production, operation, and end-of-life. The following image shows the processes considered.
+
+
+
+The method is only applicable for conventional tube and wing aircraft, powered by kerosene. This will be checked and the program skips the life cycle emission calculation in case you try to assess fancy unconventional aircraft designs :wink:.
+
+### General principles {#lca-schaefer-generalprinciples}
+For all processes within the four phases, an inventory analysis is conducted. In a first step, all relevant inputs are collected, such as materials, fuel and energy demand. Next, the resulting emissions are determined. For background processes, data provided primarily by [GaBi Software](https://ghgprotocol.org/gabi-databases) is used, offering emission data for material extraction, fuel production, energy production, and more. With this data, emissions resulting of the determined resources are calculated as follows:
+
+$ Em_{energy} = Em_{energy}^* \cdot E $
+
+$ Em_{fuel} = Em_{fuel}^* \cdot f + Em_{com}$
+
+$ Em_{mat} = Em_{mat}^* \cdot mat [kg] $
+
+with
+
+- $ Em_{energy} $: Emissions due to energy production (both electric and heat energy) [kg]
+- $ Em_{fuel} $: Emissions due to fuel production and combustion [kg]
+- $ Em_{mat} $: Emissions due to material extraction [kg]
+- $ Em_{energy}^* $: Energy specific emissions [kg/MJ]
+- $ Em_{fuel}^* $: Fuel specific production emissions [kg/kg]
+- $ Em_{mat}^* $: Material specific extraction emissions [kg/kg]
+- $ E $: Energy demand [MJ]
+- $ f $: Fuel demand [kg]
+- $ mat $: Material demand [kg]
+
+The emissions of CO2, H2O, NOx, CO, SO2, CH4, HC and soot are determined. For the testing phase during development, perfluorinated hydrocarbons (PFC), non methane volatile organic compounds (NMVOC) and nitrous oxide emissions (N2O) are additionally calculated.
+
+If recycling is enabled, emissions in the end-of-life phase can be negative, as the emissions saved in the production phase due to recycling are accounted for here.
+
+#### Development resources
+The development phase includes engineering and testing.
+
+Both electric and heat energy demand for engineering is determined by:
+
+$ E = E^* \cdot A \cdot \frac{t}{h} $
+
+with
+
+- $E$: (Electric and heat) energy $[MJ]$
+- $E^*$: Specific energy per area $[MJ/(m^2 \cdot a)]$
+- $A$: Gross floor area $[m^2]$
+- $t$: Engineering hours $[h]$
+- $h$: Hours per year $[h/a]$
+
+Testing is split into wind tunnel test, structure tests, system tests, ground tests, engine tests and flight tests.
+
+The wind tunnel tests (index: wt) only use energy E [JM], depending on the time spend in the wind tunnel t [s] and power demand P [MW]:
+
+$ E_{wt} = t_{wt} \cdot P_{wt}$.
+
+For structure tests (index: struc), production and end of life (eol) of the test components are considered. As the emissions resulting from energy, material and fuel demand of those components are calculated within the according phases, the resources are not determined here - instead, the emissions are directly summed up from existing data. Additionally, there is some energy needed for carrying out the tests. The energy E [MJ] is calculated using a linear correlation for the needed hydraulic and pneumatic power, depending on the number of load cycles n [-] and the maximum take off mass MTOM [t]:
+
+$E_{struc} = n \cdot MTOM * 1.45 \frac{J}{kg}$
+
+The system tests (index: sys) are divided into integration tests and iron bird tets. The needed energy E [MJ] is estimated using the maximum design power of the electric, pneumatic and hydraulic aircraft systems P [MW] and the testing time t [s]:
+
+$E_{sys} = P \cdot t_{sys}$
+
+In the same way, the energy for ground tests (index: gt) is determined:
+
+$E_{gt} = P \cdot t_{gt}$
+
+Additionally, emissions for taxi tests are considered. As they are calculated in the mission submodule anyway, the are summed up directly instead of calculating the resources here. It is assumed, that the total ground test time equals the flight test time, and the taxi test time is 5% of the total ground test time.
+
+Engine tests are divided into rig tests (index: rig) and test on an flying test bed (index: ftb). For the fuel demand f [kg], the number of test engines n [-], their thrust specific fuel consumption TSFC [(kg/s)/kN] and thrust T [kN] both for cruise condition c, and maximum max as well as share of those values x [-] and total time t [s] are needed:
+
+$ f_{rig} = n \cdot t_{rig} (\cdot (TSFC_{max} \cdot T_{max} \cdot x + TSFC_{c} \cdot T_{c} \cdot (1 - x))) $
+
+For the flying test bed, the fuel consumption is estimated with the fuel flow per engine, test time and number of tested engines.
+Energy and material demand for the engine tests are not calculated here, but the emissions are taken from production and end of life phase of the engine.
+
+The same is valid for the material and energy demand of the aircraft for flight tests (index: ft). The needed amount of fuel is strongly simplified and calculated with the known fuel demand of one mission (index: mission) and the flight times t [h]:
+
+$f_{ft} = f_{mission} \cdot \frac{t_{ft}}{t_{mission}}$
+
+
+#### Production resources
+For the production resources, following processes are considered:
+
+- raw material extraction (material and energy)
+- material processing (energy)
+- labour production (electric and heat energy)
+- transport to assembly location (fuel)
+- final assembly (electric and heat energy)
+- final flight test (fuel)
+
+The energy of labour is determined based on the actual working hours, the yearly working hours and the database value of energy per worker and year. The hour spend on the production is derived of the aircraft components' recurring costs:
+
+$ labourCosts = 0.41 \cdot (recurringCosts - finalAssemblyCosts) $
+
+$ energy [MJ] = specificEnergy [MJ/a] \cdot \frac{labourCosts [\$]}{wage [\$/h] \cdot hoursPerYear [h/a]} $
+
+For the material demand m [kg] of one aircraft component (index: ac), the component weight W [kg], the material ration mr [-] and the scrap ratio sr [-] are needed:
+
+$ m_{ac} = \frac{mr \cdot W}{1-sr} $
+
+This is done for all components and all considered materials (aluminum, CFRP, steel, titanium, nickel) and summed up for a total value. Whereas the competent masses are read from the aircraft exchange file, all other values can be found hardcoded in the module database. Also part of the database are the values for recycling of primary scrap. The raw material demand (index: raw) per material (index: mat)and component is:
+
+$ m_{mat, raw} = m_{ac} \cdot (1- sr \cdot recoveryRate) $
+
+Therefor, the whole raw material demand for a component is:
+
+$ m_{ac,raw} = \sum m_{mat, raw} $
+
+The energy demand for material processing does not consider the scrap ratio, as the values for specific energy demand are valid per aircraft component. The energy is calculated per material and summed up:
+
+$ E_{component} = \sum specificEnergyMaterial \cdot mr \cdot W $
+
+The fuel demand for transportation is based on a Airbus transportation network scenario which is hardcoded in the module. For every transportation/fuel type, the amount of fuel is calculated based on the components weight and transport distance:
+
+$fuel [kg] = mass [t] \cdot distance [km] * fuelConsumption [kg/(km\cdot t)]$
+
+For the final assembly, mainly personnel work and therefor electrical and heat energy is required. Again, the working hours are derived from costs:
+
+$energy [MJ] = specificEnergy[MJ/a] \cdot \frac{finalAssemblyCosts [\$]}{wage [\$/h] \cdot hoursPerYear [h/a]} $
+
+The fuel for final flight tests are determined as the first flight tests:
+
+$f_{ft} = f_{mission} \cdot \frac{t_{ft}}{t_{mission}}$
+
+#### Operation resources
+During the operation phase, flight are performed and maintenance is necessary. The needed fuel for operation can be read from the mission calculation and is not calculates in this phase. Resources for maintenance are production resources for spare parts and labour energy (heat and electricity). For the spare parts, resourced determined in the production phase are used. It is assumed, that the ratio of the maintenance material costs of a certain component and the corresponding recurring costs of that component is equal to the ratio of resources of the spare parts and of manufacturing of the specific component. For labour energy, direct maintenance costs are used and the amount of operating years t considered:
+
+$energy [MJ] = specificEnergy[MJ/a] \cdot \frac{directMaintenanceCosts [\$]}{wage [\$/h] \cdot hoursPerYear [h/a]} \cdot t [yr]$
+
+
+#### End of life resources
+In the end of life (EoL) phase, the transport to EoL-site, disassembly, dismantling and recycling/incineration/landfill are considered.
+The transport to EoL-site is handled like a flight with a certain distance and the fuel demand f determined via the range R [NM] of this flight compared to the range of the known mission:
+
+$f_{EoL} = f_{mission} \cdot \frac{R_{EoL}}{R_{mission}}$
+
+Resources for disassembly and dismantling are determined as for the final assembly, but no heat energy is required as the the process takes place outdoors.
+
+$energy [MJ] = specificEnergy[MJ/a] \cdot \frac{costs [\$]}{wage [\$/h] \cdot hoursPerYear [h/a]} \cdot t [yr]$
+
+The EoL scenario hardcoded in the module contains recycling, incineration and landfill rates for the aircraft components. The energy needed for all materials/components and all cases is summed up. With the ratios if incineration and landfill, the energy for all components and materials are calculated like this:
+
+$ energy [MJ] = specificEnergy [MJ/kg] \cdot componentMass \cdot $
+
+For recycling, the energy rate ER is needed additionally:
+
+$ energy [MJ] = \frac{1}{ER} \cdot specificEnergy [MJ/kg] \cdot componentMass \cdot $
+
+### Input data {#lca-schaefer-input}
+The calculation results depend on following user inputs the aircraft exchange file:
+```xml
+- requirements_and_specifications
+ - general
+ - type
+ - model
+ - design_specification
+ - transport_task
+ - passenger_definition
+ - total_number_passengers
+ - requirements
+ - top_level_aircraft_requirements
+ - flight_envelope
+ - maximum_operating_velocity
+ - study_mission
+ - range
+ - payload_fractions
+ - passenger_mass_fraction
+ - assessment_scenario
+ - flights_per_year
+ - duration_operation
+ - mission_files
+ - design_mission_file
+```
+Additionally, results from other Unicado tools are needed:
+```xml
+- component_design
+ - propulsion
+ - specific
+ - propulsion (ID="0")
+ - engine
+ - scale_factor
+ - model
+ - bucket_point
+ - thrust
+ - tsfc
+ - mass_properties
+ - mass
+ - nacelle (ID="0")
+ - mass_properties
+ - mass
+ - pylon (ID="0")
+ - mass_properties
+ - mass
+ - mass_properties
+ - mass
+ - systems
+ - specific
+ - maximium_power_demand
+ - geometry
+ - mass_properties
+ - bleed_air_system
+ - fuel_system
+ - mass_properties
+ - mass
+ - wing
+ - mass_properties
+ - mass
+ - fuselage
+ - mass_properties
+ - mass
+ - landing_gear
+ - mass_properties
+ - mass
+ - empennage
+ - specific
+ - geometry
+ - aerodynamic_surface (ID="0")
+ - name
+ - mass_properties
+ - mass
+ - aerodynamic_surface (ID="1")
+ - name
+ - mass_properties
+ - mass
+- analysis
+ - aerodynamics
+ - reference_values
+ - S_ref
+ - masses_cg_inertia
+ - maximum_takeoff_mass
+ - mass_properties
+ - mass
+ - operating_mass_empty
+ - mass_properties
+ - mass
+ - manufacturer_mass_empty
+ - mass_properties
+ - mass
+ - mission
+ - design_mission
+ - range
+ - block_time
+ - flight_time
+ - taxi_energy (ID="0")
+ - taxi_out_energy (ID="0")
+ - consumed_energy
+ - study_mission
+ - flight_time
+ - taxi_energy (ID="0")
+ - taxi_out_energy (ID="0")
+ - consumed_energy
+ - in_flight_energy
+ - trip_energy (ID="0")
+ - consumed_energy
+```
+In the `ecological_assessment_conf.xml`, you can specify calculation modes and input parameters like testing hours for the different phases. Next to the control settings block, the following program settings can be set:
+```xml
+- emission_calculation
+ - life_cycle_emissions_methods
+ - method
+ - schaefer
+ - engine_mode_switch
+ - engine_engineering_ratio
+ - development_phase
+ - test_phase
+ - development_emission_setting
+ - aircraft_specs
+ - ETOPS_switch
+ - engine_options
+ - wind_tunnel_test
+ - test_hours
+ - structural_test
+ - test_cycles
+ - number_of_structural_test_aircraft
+ - system_test
+ - system_integration_test_hours
+ - iron_bird_test_hours
+ - engine_test
+ - enable
+ - number_of_new_engines
+ - number_of_test_engines
+ - rig_test
+ - test_hours
+ - max_continuous_thrust_percentage
+ - flying_testbed
+ - test_hours
+ - flying_testbed_engines
+ - engine_number
+ - flying_testbed_fuel_consumption_per_engine
+ - flight_test
+ - test_hours
+ - number_of_flight_test_aircraft
+ - production_phase
+ - production_mode
+ - primary_material_recycling_switch
+ - number_produced_aircraft
+ - end_of_life_phase
+ - distance_to_end_of_life_site
+```
+Other inputs are mission related. The design mission taxi time is needed and read from the *design_mission.xml*:
+
+```xml
+- taxi_time_origin
+- taxi_time_destination
+```
+
+And last but not least, the emissions provided by the submodule [mission_emissions](mission_emissions) will be read from *ecological_assessment_results.xml*:
+
+```xml
+- mission_emissions
+ - design_mission
+ - emissions
+ - LTO_cycle
+ - CO2
+ - H2O
+ - SO2
+ - SO4
+ - HC
+ - CH4
+ - CO
+ - NOx
+ - soot
+ - c_soot_LTO_max
+ - cruise
+ - CO2
+ - H2O
+ - SO2
+ - SO4
+ - HC
+ - CH4
+ - CO
+ - NOx
+ - soot
+ - study_mission
+ - emissions
+ - LTO_cycle
+ - CO2
+ - H2O
+ - SO2
+ - SO4
+ - HC
+ - CH4
+ - CO
+ - NOx
+ - soot
+ - c_soot_LTO_max
+ - cruise
+ - CO2
+ - H2O
+ - SO2
+ - SO4
+ - HC
+ - CH4
+ - CO
+ - NOx
+ - soot
+```
+### Output data {#lca-schaefer-output}
+The Method writes data to CSV files in the *aircraft\_exchange\_file\_directory/reporting/plots/csv_files* folder containing emissions, energy demand, fuel demand and GWP100 for all processes. Additionally, total emissions of the four phases are written to the `ecological_assessment_results.xml`. As described in [Usage of the ecological_assessment tool](#usage), an HTML report including a plot will be generated.
+
+## Air Quality Index Schaefer {#aqi-schaefer}
+This method provides a single indicator - called the Air Quality Index (AQI) - for the assessment of air quality. The AQI can take values between 0 and 1, with 1 indicating that the allowable limits defined by ICAO are reached by all species. Therefore, low values are preferable.
+
+### General principles {#aqi-schaefer-generalprinciples}
+The calculation method, including all required inputs, is described in Schaefer (2017) \cite Sch17. It is:
+
+$ AQI = 1/n \cdot \sum x_i/x_{i,max}$
+
+where:
+
+- $ x_i $: emission mass [g] ( for CO, HC, NOx) or maximum concentration [mg/m^3] ( for soot) during the landing and takeoff cycle,
+- $ x_{i,max}$: regulatory value defined by ICAO, the ratio of emission mass Dp [g] emitted during LTO and the rated thrust F00 [kN],
+- $ n $: number of emission species.
+
+### Input data {#aqi-schaefer-input}
+Only engine and emission data are needed. To construct the engine object, the following is required from aircraft exchange file:
+```xml
+- component_design
+ - propulsion
+ - specific
+ - propulsion (ID="0")
+ - engine
+ - engine_model
+ - scale_factor
+```
+
+From `ecological_assessment_results.xml` the emissions during LTO of the study mission are needed:
+```xml
+- mission_emissions
+ - study_mission
+ - emissions
+ - LTO_cycle
+ - HC
+ - CO
+ - NOx
+ - c_soot_LTO_max
+```
+### Output data {#aqi-schaefer-output}
+The submodule writes its calculation results into the HTML report located in *aircraft_exchange_file_directory/reporting/report_html*.
+
+## Climate Model Dallara {#climate-model-dallara}
+The climate model calculates key climate impact metrics: Radiative Forcing (RF), Absolute Global Warming Potential (AGWP), Absolute Global Temperature Potential (AGTP), and Average Temperature Response (ATR). The calculation methodology is derived from Dallara's work in 2011 \cite Dal11, providing a systematic approach to assess the environmental effects of various emissions.
+
+The key metrics are:
+
+- **RF**: quantifies the change in energy flux in the Earth's atmosphere due to emissions, specifically related to greenhouse gases, aerosols, and other components like soot or water vapor.
+- **AGWP**: measures the cumulative impact of an emission over a specific time horizon (typically 20, 100, or 500 years), comparing it to CO₂'s effect.
+- **AGTP**: calculates the temperature change due to emissions at a given point in time, typically looking at how gases contribute to warming.
+- **ATR**: ATR evaluates the mean temperature change over time.
+
+The model assesses the climate impact of following emissions:
+
+- CO₂ (Carbon dioxide)
+- H₂O (Water vapor)
+- Soot (Black carbon)
+- Ozone (O₃) (both long-lived and short-lived forms) and CH₄ (Methane), which are influenced by NOₓ emissions
+
+Additionally aircraft induced cloudiness (AIC) is considered.
+
+A particular feature of the method is the usage of forcing factors, which are unitless parameters. These factors modify the radiative forcing for emissions at different altitudes by normalizing the RF values to a fleet wide average. The altitude is the only flight trajectory parameter considered, meaning the geographic location is not factored into the calculations. This altitude dependency recognizes that emissions at higher altitudes (such as those from aviation) have a different forcing impact compared to emissions at ground level, as atmospheric processes and the distribution of pollutants vary with height.
+
+In the model, you can explore how the influence of time affects climate impact by adjusting the rate of devaluation for temperature response. A value of zero indicates that the temperature changes occurring after operations are given equal weight compared to changes during the operational period. Higher values of the rate, however, signify that postoperation impacts become progressively less important over time, with each subsequent year's temperature change being less significant than that of the previous year.
+
+### General principles {#climate-model-generalprinciples}
+The submodules is based on the emissions calculated by the mission submodule. The values are read and scaled to one year, to get the yearly emission mass E.
+
+To calculate the radiative forcing following formulas are used:
+
+$ RF(t, h) = s_i(h) \cdot \int_{0}^{t} G_i(t-\tau)E_i(\tau)d\tau$ for $i \in [CO_2, O_{3L}, CH_4]$
+
+$ RF(t, h) = s_i(h) \cdot \left(\frac{RF_{ref}}{E_{ref}}\right)\cdot E_i(t)$ for $i \in [H_2O, O_{3S}, soot, SO_4]$
+
+$ RF_{AIC}(t, h) = s_{AIC}(h) \cdot \left(\frac{RF_{ref}}{L_{ref}}\right)_{AIC}\cdot L(t)$
+
+with
+
+- $RF$: radiative forcing [W/m^2]
+- $s_i$: forcing factor [-]
+- $G_i$: response function [W/m2/kg]
+- $t$: current year [a]
+- $\tau$: considered time frame [a]
+- $\frac{RF_{ref}}{E_{ref}}$: reference parameter (radiative forcing per emission unit) [W/m2/kg]
+- $E_i$: yearly emission mass [kg]
+- $L$: yearly flown range [NM]
+- $\frac{RF_{ref}}{L_{ref}}$: reference parameter (radiative forcing per flown NM) [W/m2/NM]
+
+The forcing factors can be interpolated from given data and average values per mission are determined, considering climb, cruise and approach phase.
+
+In a next step, the radiative forcing is normalized with the species' efficacy f and $RF_{2xCO_2}$, the RF which would result from a doubling of CO2:
+
+$RF^{*}_{i}(t,h) = f_i \cdot \frac{RF_i(t,h)}{RF_{2xCO_2}} $
+
+With these values, a temperature change can be determined:
+
+$\Delta T(t) = \int_{0}^{t} G_t(t-\tau)\left[\sum_{i} RF^*_i (\tau)\right]d\tau$
+
+with the response function:
+
+$G_T(t) = S\cdot \left[\frac{\alpha_t}{\tau_{t1}} \exp\left(-\frac{t}{\tau_{t1}}\right) + \frac{1 - \alpha_t}{\tau_{t2}}
+\exp\left(-\frac{t}{\tau_{t2}}\right)\right]$
+
+All parameters $\alpha$, $\tau$ and $S$ are constants taken from literature.
+
+The temperature change is weighted afterwards:
+
+$\Delta T_{weighted}(t) = \Delta T(t) \cdot w(t)$
+
+with the weighting function:
+
+$w(t) = \begin{cases}
+ 1, & t < H \\
+ \frac{1}{(1 + r)^{(t - H)}}, & H < t\le t_{max}\\
+ 0, & t > t_{max}
+ \end{cases}
+$
+
+with
+
+- $t$: current year
+- $t_{max}$: considered time frame
+- $H$: years of operation
+- $r$: devaluation rate [-]
+
+In a last step, the average temperature response ATR is calculated:
+
+$ATR_i = \frac{1}{H} \cdot \int_{0}^{t_{max}} \Delta T_{weighted}(t) $
+
+The overall ATR is then:
+
+$ATR = \sum_{i} ATR_i$
+
+### Input data {#climate-model-input}
+From the aircraft exchange file following parameter are needed:
+```xml
+- requirements_and_specifications
+ - design_specification
+ - assessment_scenario
+ - flights_per_year
+ - analysis
+ - mission
+ - study_mission
+ - range
+ - cruise
+ - top_of_climb_range
+ - top_of_descent_range
+ - cruise_steps
+ - cruise_step (ID="0")
+ - relative_end_of_cruise_step
+ - altitude
+```
+The submodule reads following data from the program settings in the configuration file:
+```xml
+- standard_strategy
+ - impact_calculation
+ - climate_model_methods
+ - method
+ - dallara
+ - fuel_factor_AIC
+ - max_integration_period
+ - devaluation_rate
+ - forcing_factors
+ - variations
+ - aircraft_induced_cloudiness
+ - short_lived_ozone
+ - methan_and_long_lived_ozone
+ - data_set_selector
+```
+
+Additionally, the emission masses of the study missions are needed:
+```xml
+- mission_emissions
+ - study_mission
+ - emissions
+ - LTO_cycle
+ - CO2
+ - H2O
+ - SO4
+ - NOx
+ - soot
+ - cruise
+ - CO2
+ - H2O
+ - SO4
+ - NOx
+ - soot
+```
+
+
+### Output data {#climate-model-output}
+The results are saved within the following files:
+
+- acXML parameter: The average temperature response is written to `/aircraft_exchange_file/assessment/ecological_assessment/average_temperature_response`
+- html report: AGWP, AGWP100, AGTP, AGTP100 and ATR are written to `aircraft_exchange_file_directory/reporting/reportHTML/ecological_assessment_report.html`
+- tex report: `aircraft_exchange_file_directory/reporting/reportTeX/ecological_assessment_report.tex`
+- csv file: Emission masses, (normalized) radiative forcing, (weighted) temperature change, AGTP, AGWP and ATR both per emission species and total are written for all considered years into `aircraft_exchange_file_directory/reporting/plots/csv_files/ecological_assessment_climate_impact.csv`
\ No newline at end of file
diff --git a/docs/documentation/analysis/ecological_assessment/climate_model_dallara.md b/docs/documentation/analysis/ecological_assessment/climate_model_dallara.md
deleted file mode 100644
index 92cce68..0000000
--- a/docs/documentation/analysis/ecological_assessment/climate_model_dallara.md
+++ /dev/null
@@ -1,214 +0,0 @@
-# climate_model_dallara {#climate-model-dallara}
-The climate model, referred to here as the "Dallara" model, calculates key climate impact metrics: Radiative Forcing (RF), Absolute Global Warming Potential (AGWP), Absolute Global Temperature Potential (AGTP), and Average Temperature Response (ATR). The calculation methodology is derived from Dallara's work in 2011 \cite Dal11, providing a systematic approach to assess the environmental effects of various emissions.
-
-Key Metrics:
-- **RF**: quantifies the change in energy flux in the Earth's atmosphere due to emissions, specifically related to greenhouse gases, aerosols, and other components like soot or water vapor.
-- **AGWP**: measures the cumulative impact of an emission over a specific time horizon (typically 20, 100, or 500 years), comparing it to CO₂'s effect.
-- **AGTP**: calculates the temperature change due to emissions at a given point in time, typically looking at how gases contribute to warming.
-- **ATR**: ATR evaluates the mean temperature change over time.
-
-
-## General principles {#climate-model-generalprinciples}
-The model assesses the climate impact of following emissions:
-- CO₂ (Carbon dioxide)
-- H₂O (Water vapor)
-- Soot (Black carbon)
-- Ozone (O₃) (both long-lived and short-lived forms) and CH₄ (Methane), which are influenced by NOₓ emissions
-
-A particular feature of the method is the usage of forcing factors, which are unitless parameters. These factors modify the radiative forcing for emissions at different altitudes by normalizing the RF values to a fleetwide average. The altitude is the only flight trajectory parameter considered, meaning the geographic location is not factored into the calculations. This altitude dependency recognizes that emissions at higher altitudes (such as those from aviation) have a different forcing impact compared to emissions at ground level, as atmospheric processes and the distribution of pollutants vary with height.
-
-In the model, you can explore how the influence of time affects climate impact by adjusting the rate of devaluation for temperature response. A value of zero indicates that the temperature changes occurring after operations are given equal weight compared to changes during the operational period. Higher values of the rate, however, signify that postoperation impacts become progressively less important over time, with each subsequent year's temperature change being less significant than that of the previous year.
-
-## Input-Data {#climate-model-input}
-From the acxml following parameter are needed:
-```xml
-<aircraft_exchange_file>
- <requirements_and_specifications>
- <design_specification>
- <assessment_scenario>
- <flights_per_year>
- <unit>1</unit>
- <value>2227</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>4000</upper_boundary>
- </flights_per_year>
- </assessment_scenario>
- </design_specification>
- </requirements_and_specifications>
- <anlysis>
- <study_mission>
- <range>
- <unit>m</unit>
- <value>927191.902</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>5000000</upper_boundary>
- </range>
- <top_of_climb_range>
- <unit>m</unit>
- <value>140079.6691</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>5000000</upper_boundary>
- </top_of_climb_range>
- <top_of_descent_range>
- <unit>m</unit>
- <value>741036.0403</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>5000000</upper_boundary>
- </top_of_descent_range>
- <cruise_steps>
- <cruise_step ID="0">
- <relative_end_of_cruise_step>
- <unit>1</unit>
- <value>1</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1</upper_boundary>
- </relative_end_of_cruise_step>
- <altitude>
- <unit>m</unit>
- <value>10668</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>15000</upper_boundary>
- </altitude>
- </cruise_step>
- </cruise_steps>
- </study_mission>
- </anlysis>
-</aircraft_exchange_file>
-```
-The Submodel reads following data from the path `module_configuration_file/program_settings/standard_strategy/impact_calculation`in the configuration file:
-```xml
-<climate_model_methods>
- <method>
- <value>DALLARA</value>
- </method>
- <dallara>
- <fuel_factor_AIC>
- <unit>1</unit>
- <value>0.6</value>
- <lower_boundary>0.3</lower_boundary>
- <upper_boundary>1</upper_boundary>
- </fuel_factor_AIC>
- <max_integration_period>
- <unit>a</unit>
- <value>200</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1000</upper_boundary>
- </max_integration_period>
- <devaluation_rate>
- <unit>1</unit>
- <value>0.03</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10^10</upper_boundary>
- </devaluation_rate>
- <forcing_factors>
- <variations>
- <aircraft_induced_cloudiness>
- <unit>1</unit>
- <value>1</value>
- <lower_boundary>0.67</lower_boundary>
- <upper_boundary>1.33</upper_boundary>
- </aircraft_induced_cloudiness>
- <short_lived_ozone>
- <unit>1</unit>
- <value>1</value>
- <lower_boundary>0.67</lower_boundary>
- <upper_boundary>1.33</upper_boundary>
- </short_lived_ozone>
- <methan_and_long_lived_ozone>
- <unit>1</unit>
- <value>1</value>
- <lower_boundary>0.67</lower_boundary>
- <upper_boundary>1.33</upper_boundary>
- </methan_and_long_lived_ozone>
- </variations>
- <data_set_selector>
- <value>mode_0</value>
- </data_set_selector>
- </forcing_factors>
- </dallara>
-</climate_model_methods>
-```
-
-Additionally, the emission masses of the study missions are needed:
-```xml
-<calculation_results description="Results of calculation method">
- <mission_emissions description="Results of mission emission calculation">
- <study_mission description="Results of study mission calculation">
- <emissions description="Emissions of study mission">
- <LTO_cycle description="Emissions of landing and takeoff cycle">
- <CO2 description="LTO CO2 emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CO2>
- <H2O description="LTO H2O emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </H2O>
- <SO4 description="LTO SO4 emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </SO4>
- <NOx description="LTO NOx emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </NOx>
- <soot description="LTO Soot emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </soot>
- </LTO_cycle>
- <cruise description="Emissions of cruise phase">
- <CO2 description="Cruise CO2 emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CO2>
- <H2O description="Cruise H2O emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </H2O>
- <SO4 description="Cruise SO4 emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </SO4>
- <NOx description="Cruise NOx emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </NOx>
- <soot description="Cruise Soot emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </soot>
- </cruise>
- </emissions>
- </study_mission>
- </mission_emissions>
-</calculation_results>
-```
-
-
-## Output-Data {#climate-model-output}
-The results are saved within the following files:
-- acXML parameter: `/aircraft_exchange_file/assessment/ecological_assessment/average_temperature_response`
-- html report: `aircraft_exchange_file_directory/reporting/reportHTML/ecological_assessment_report.html`
-- tex report: `aircraft_exchange_file_directory/reporting/reportTeX/ecological_assessment_report.tex`
-- csv file: `aircraft_exchange_file_directory/reporting/plots/csv_files/ecological_assessment_climateImpact.csv`
\ No newline at end of file
diff --git a/docs/documentation/analysis/ecological_assessment/getting-started.md b/docs/documentation/analysis/ecological_assessment/getting-started.md
deleted file mode 100644
index ffa00dd..0000000
--- a/docs/documentation/analysis/ecological_assessment/getting-started.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# Getting Started {#getting-started}
-
-## Tool execution
-This guide will show you the basic usage of the _ecological\_assessment_ tool.
-
-!!! note
- It is assumed that you have the `UNICADO Package` installed, including the executables and UNICADO libraries. If you are a developer, you need to build the tool first (see [build instructions on the UNICADO website](../../../get-involved/build/cpp/)).
-
-The following steps are necessary:
-1. Create a dummy `aircraft_exchange_file` and provide all other required inputs (for submodule-dependent minimal required inputs see [here](#submodules)).
-2. Fill out the configuration file:
- - change at least in `control_settings`:
- - `aircraft_exchange_file_name` and `aircraft_exchange_file_directory` to your respective settings
- - set `console_output` at least to `mode_1`
- - set `plot_output` to false (or define `inkscape_path` and `gnuplot_path`)
- - all other parameters can be left at default values.
-3. Open the terminal and run _ecological\_assessment.exe_
-
-The following will happen:
-- you will see output in the console window
-- a `.log` file is written within the directory of the executable
-- an HTML report is created in the directory of `aircraft_exchange_file_directory/reporting/reportHTML`
-- depending on your chosen methods, results are saved in
- - `/aircraft_exchange_file/assessment/average_temperature_response`
- - and/or in the files you'll find in the `aircraft_exchange_file_directory/reporting/plots/` directory
- - and/or in the files you'll find in the `aircraft_exchange_file_directory/reporting/plots/csv_files` directory.
-
-Be aware of the files' timestemp as there could be leftovers of earlier programm executions!
-
-## Changing user input
-If you want to adapt the tool's execution, you can modify the parameters within the configuration file. There, you can enable or disable specific aspects of the ecological assessment and select the methods to be used for the calculations. At the [submodule pages](#submodules), you can check which parameters are available.
-
diff --git a/docs/documentation/analysis/ecological_assessment/index.md b/docs/documentation/analysis/ecological_assessment/index.md
index 69c19a1..776e1d9 100644
--- a/docs/documentation/analysis/ecological_assessment/index.md
+++ b/docs/documentation/analysis/ecological_assessment/index.md
@@ -1,10 +1,41 @@
# Introduction {#mainpage}
-The tool _ecological\_assessment_ is one of the last modules in the UNICADO toolchain, serving as an assessment module executed after the aircraft sizing loop. As its name suggests, it is specifically designed to evaluate the ecological performance of your aircraft design. By using this tool, you gain the opportunity to contribute to the development of environmentally friendly aircraft, playing a part in shaping a sustainable future for aviation. ✈️🌱🌎
+The tool _ecological\_assessment_ is one of the last modules in the UNICADO toolchain, serving as an assessment module executed after the aircraft sizing loop. As its name suggests, it is made to evaluate the ecological performance of your aircraft design. By using this tool, you gain the opportunity to contribute to the development of environmentally friendly aircraft, playing a part in shaping a sustainable future for aviation. ✈️🌱🌎
-This module enables you to assess various ecological factors, including aircraft emission masses and their broader environmental impacts. These impacts are analyzed, for example, in terms of their contributions to climate change and air quality, helping you understand the environmental footprint of your design in a comprehensive way.
+The module enables you to assess various ecological factors, including aircraft emission masses and their broader environmental impacts. These impacts are analyzed, for example, in terms of their contributions to climate change and air quality, helping you understand the environmental footprint of your design in a comprehensive way.
-The _ecological\_assessment_ tool offers flexibility in how you approach these evaluations. You can choose to perform a complete life cycle assessment (LCA), which evaluates the environmental impact across the entire lifespan of the aircraft — from development and production through operation to end-of-life, including eventual disposal. Alternatively, if you're focusing on the operational phase, you can limit the analysis to the impact of the flown mission alone.
+The _ecological\_assessment_ tool offers flexibility in how you approach these evaluations. You can choose to perform a complete life cycle assessment (LCA), which evaluates the environmental impact across the entire lifespan of the aircraft — from development and production through operation to end-of-life, including eventual disposal. Alternatively, if you're focusing on the operational phase, you can limit the analysis to the impact of the flown mission alone. The following table provides information about the implemented methods:
-If you want to explore the details of the _ecological\_assessment_ module and discover how to optimize your aircraft designs for environmental sustainability, check out the next section of this documentation. The @subpage getting-started gives you a first insight into how to execute the tool. To understand how the tool works, the documentation is split into a @subpage softwarearchitecture section, where the structure of the module is described.
+Topic | Configuration | Energy carrier | Fidelity | Method |
+---------------------------|---------------|------------------|-----------|-----------|
+Emissions of flown mission | All | Kerosene or LH2 | Empirical | Unicado |
+Life cycle emissions/energy| Tube and wing | Kerosene | Empirical | Schaefer |
+Air quality index | All | Kerosene or LH2 | Empirical | Schaefer |
+Climate impact | All | Kerosene or LH2 | Empirical | Dallara |
+
+If you want to explore the details of the _ecological\_assessment_ module and discover how to optimize your aircraft designs for environmental sustainability, check out the next section of this documentation.
+
+## A User's Guide to Ecological Assessment
+This user documentation will guide you through all necessary steps to understand the tool as well as the necessary inputs and configurations to determine the ecological impact of your aircraft design.
+
+The following pages will guide you through the theory behind the calculations and the process of computing and analyzing the ecological impact within UNICADO:
+
+- [Basic Concepts](basic-concepts.md)
+- [Usage of the Ecological Assessment Tool](usage.md)
So let's get started! ✈️
+
+
+## You are a Developer?
+
+If you are familiar with the above mentioned concepts and want to contribute - head over to the developers guide to get your own method running in UNICADO!
+
+The following pages will help you to get into coding:
+
+- [Developer Guide](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/developer-installation/)
+- [Build Instructions](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/build/general/)
+- [Module Structure in c++](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/style/cpp-modularization/)
+- [UNICADO C++ Style Guide](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/style/cpp/)
+- [Tool Structure of ecological_assessment ](software-architecture.md)
+
+!!!note
+ The methods of this module will not be extended by the UNICADO team. We are currently working on an additional assessment module, which combines economical and ecological assessment (including noise). You are nevertheless encouraged to improve and extend this module until the new one is published. We appreciate your ideas and will merge the modules afterwards - so no work will be lost! 💪
diff --git a/docs/documentation/analysis/ecological_assessment/lca_schaefer.md b/docs/documentation/analysis/ecological_assessment/lca_schaefer.md
deleted file mode 100644
index d03f517..0000000
--- a/docs/documentation/analysis/ecological_assessment/lca_schaefer.md
+++ /dev/null
@@ -1,815 +0,0 @@
-
-# LCA_schaefer {#lca-schaefer}
-The method is based on the dissertation by Katharina Schäfer (2011) \cite Sch17. It is highly recommended to refer to this work for detailed insights. The method calculates the energy demand and emissions across the aircraft's life cycle phases: development, production, operation, and end-of-life. The following image shows the processes considered.
-
-
-
-## General principles {#lca-schaefer-generalprinciples}
-For all processes within the four phases, an inventory analysis is conducted. The function `calculateResources` collects all relevant inputs, such as materials and energy demand. Next, `calculateEmissions` determines the resulting emissions. For background processes, data provided primarily by [GaBi Software](https://ghgprotocol.org/gabi-databases) is used, offering emission data for material extraction, fuel production, energy production, and more.
-If recycling is enabled, emissions in the end-of-life phase can be negative, as the emissions saved in the production phase due to recycling are accounted for here.
-
-## Input-Data {#lca-schaefer-input}
-!!! note
- The following lists show only the data that is directly read by the module. For data required by the libraries in use, please refer to the respective documentation.
-
-The method reads following data from the acXML file:
-```xml
-<aircraft_exchange_file>
- <requirements_and_specifications>
- <general>
- <type>
- <value>CeRAS</value>
- </type>
- <model>
- <value>SMR-2020</value>
- </model>
- </general>
- <design_specification>
- <transport_task>
- <passenger_definition>
- <total_number_passengers>
- <unit>1</unit>
- <value>162</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1000</upper_boundary>
- </total_number_passengers>
- </passenger_definition>
- </transport_task>
- </design_specification>
- <requirements>
- <top_level_aircraft_requirements>
- <flight_envelope>
- <maximum_operating_velocity>
- <unit>m/s</unit>
- <value>180</value>
- <lower_boundary>50</lower_boundary>
- <upper_boundary>250</upper_boundary>
- </maximum_operating_velocity>
- </flight_envelope>
- <study_mission>
- <range>
- <unit>m</unit>
- <value>1481600</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>20000000</upper_boundary>
- </range>
- <payload_fractions>
- <passenger_mass_fraction>
- <unit>1</unit>
- <value>0.75</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1</upper_boundary>
- </passenger_mass_fraction>
- </payload_fractions>
- </study_mission>
- </top_level_aircraft_requirements>
- </requirements>
- <assessment_scenario>
- <flights_per_year>
- <unit>1</unit>
- <value>2227</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>4000</upper_boundary>
- </flights_per_year>
- <duration_operation>
- <unit>a</unit>
- <value>25</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>50</upper_boundary>
- </duration_operation>
- </assessment_scenario>
- <mission_files>
- <design_mission_file>
- <value>design_mission.xml</value>
- </design_mission_file>
- </mission_files>
- </requirements_and_specifications>
- <component_design>
- <propulsion>
- <specific>
- <propulsion ID="0">
- <engine>
- <scale_factor>
- <unit>1</unit>
- <value>0.9064775155</value>
- <lower_boundary>-inf</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </scale_factor>
- <model>
- <value>PW1127G-JM</value>
- </model>
- <bucket_point>
- <thrust>
- <unit>N</unit>
- <value>18391.6134</value>
- <lower_boundary>-inf</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </thrust>
- <tsfc>
- <unit>kg/Ns</unit>
- <value>1.407077304e-05</value>
- <lower_boundary>-inf</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </tsfc>
- </bucket_point>
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>2565.399255</value>
- <lower_boundary>-inf</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </engine>
- <nacelle ID="0">
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>1021.17164</value>
- <lower_boundary>-inf</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </nacelle>
- <pylon ID="0">
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>495.2910093</value>
- <lower_boundary>-inf</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </pylon>
- </propulsion>
- </specific>
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>8163.723809</value>
- <lower_boundary>-inf</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </propulsion>
- <systems>
- <specific>
- <maximium_power_demand>
- <unit>W</unit>
- <value>249540.7594</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </maximium_power_demand>
- <geometry>
- <mass_properties>
- <bleed_air_system>
- <unit>kg</unit>
- <value>170.9024353</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </bleed_air_system>
- <fuel_system>
- <unit>kg</unit>
- <value>0</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </fuel_system>
- </mass_properties>
- </geometry>
- </specific>
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>4825.986695</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </systems>
- <wing>
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>5899.686597</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </wing>
- <fuselage>
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>14004.22881</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </fuselage>
- <landing_gear>
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>2558.0104</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </landing_gear>
- <empennage>
- <specific>
- <geometry>
- <aerodynamic_surface ID="0">
- <name>
- <value>vertical_stabiliser</value>
- </name>
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>566.1125139</value>
- <lower_boundary>-inf</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </aerodynamic_surface>
- <aerodynamic_surface ID="1">
- <name>
- <value>horizontal_stabiliser</value>
- </name>
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>759.3554913</value>
- <lower_boundary>-inf</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </aerodynamic_surface>
- </geometry>
- </specific>
- </empennage>
- </component_design>
- <analysis>
- <aerodynamics>
- <reference_values>
- <S_ref>
- <unit>m^2</unit>
- <value>105.2800817</value>
- <lower_boundary>-inf</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </S_ref>
- </reference_values>
- </aerodynamics>
- <masses_cg_inertia>
- <maximum_takeoff_mass>
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>64586.71283</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>300000</upper_boundary>
- </mass>
- </mass_properties>
- </maximum_takeoff_mass>
- <operating_mass_empty>
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>36354.88581</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </operating_mass_empty>
- <manufacturer_mass_empty>
- <mass_properties>
- <mass>
- <unit>kg</unit>
- <value>33257.87662</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </manufacturer_mass_empty>
- </masses_cg_inertia>
- <mission>
- <design_mission>
- <range>
- <unit>m</unit>
- <value>4538402.27</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>5000000</upper_boundary>
- </range>
- <block_time>
- <unit>s</unit>
- <value>20978.31905</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>45000</upper_boundary>
- </block_time>
- <flight_time>
- <unit>s</unit>
- <value>20138.31905</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>44500</upper_boundary>
- </flight_time>
- <taxi_energy ID="0">
- <taxi_out_energy ID="0">
- <consumed_energy>
- <unit>J</unit>
- <value>0</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1e+12</upper_boundary>
- </consumed_energy>
- </taxi_out_energy>
- </taxi_energy>
- </design_mission>
- <study_mission>
- <flight_time>
- <unit>s</unit>
- <value>20138.31905</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>44500</upper_boundary>
- </flight_time>
- <taxi_energy ID="0">
- <taxi_out_energy ID="0">
- <consumed_energy>
- <unit>J</unit>
- <value>0</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1e+12</upper_boundary>
- </consumed_energy>
- </taxi_out_energy>
- </taxi_energy>
- <in_flight_energy>
- <trip_energy ID="0">
- <consumed_energy>
- <unit>J</unit>
- <value>0</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1e+12</upper_boundary>
- </consumed_energy>
- </trip_energy>
- </in_flight_energy>
- </study_mission>
- </mission>
- </analysis>
-</aircraft_exchange_file>
-```
-In the `ecological_assessment_conf.xml`, next to the control settings block, the following program settings are needed:
-```xml
-<program_settings description="Program specific settings for this tool">
- <strategy_selector description="Define which strategy shall be used. By now, only 'standard' is implemented which offers different methods">
- <value>STANDARD</value>
- </strategy_selector>
- <standard_strategy description="Settings for standard strategy. Different methods can be used by defining them in this block.">
- <emission_calculation description="Settings for the emission calculation">
- <life_cycle_emissions_methods description="Settings for life cylce emission calculation">
- <method description="Sets method to calculate life cycle emissions ('NO': no calculation, 'SCHAFER': calculation according to K.Schäfer(2018)">
- <value>SCHAEFER</value>
- </method>
- <schaefer description="Settings for the emission calculations according to K.Schäfer(2018)">
- <engine_mode_switch description="Includes engine life cycle in calculation (Dev+Production+Maintenance+EoL). Switch: true (engine included) / false (engine not included)">
- <value>true</value>
- </engine_mode_switch>
- <engine_engineering_ratio description="Engineering effort for engines relative to whole aircraft (derived from Micado CSR-02 costs)">
- <value>0.2113</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1</upper_boundary>
- </engine_engineering_ratio>
- <development_phase description="Settings for the calculation of the development phase">
- <test_phase description="Settings for calculation of test emissions">
- <development_emission_setting description="Selects scope of development emission calculation. Selector: mode_0 (no development emissions) / mode_1 (development emissions without production/endOfLife emissions of test components) / mode_2 (development emissions with production/endOfLife emissions of test components)">
- <value>mode_2</value>
- </development_emission_setting>
- <aircraft_specs description="Aircraft specifications needed for development calculations">
- <ETOPS_switch description="Aircraft and engine(s) will be tested for ETOPS (Extended-range Twin-engine Operations Performance Standards) approval, engine test: additional 3000 test cycles (a 0.5h). Switch: true (test) / false (no test)">
- <value>false</value>
- </ETOPS_switch>
- <engine_options description="Number of engine options for this aircraft">
- <value>2</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10</upper_boundary>
- </engine_options>
- </aircraft_specs>
- <wind_tunnel_test description="Settings for wind tunnel test">
- <test_hours description="Number of wind tunnel hours in aircraft development">
- <value>15000</value>
- <unit>h</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>150000</upper_boundary>
- </test_hours>
- </wind_tunnel_test>
- <structural_test description="Settings for structural test">
- <test_cycles description="Number of tested flight cycles in aircraft development (twice the number of flight cycles for which the aircraft will be certified)">
- <value>160000</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>500000</upper_boundary>
- </test_cycles>
- <number_of_structural_test_aircraft description="Number of aircraft for structural tests">
- <value>2</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10</upper_boundary>
- </number_of_structural_test_aircraft>
- </structural_test>
- <system_test description="Settings for system tests">
- <system_integration_test_hours description="Test hours at the system integration test rig">
- <value>5000</value>
- <unit>h</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10000</upper_boundary>
- </system_integration_test_hours>
- <iron_bird_test_hours description="Test hours on the Iron-Bird test rig">
- <value>5000</value>
- <unit>h</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10000</upper_boundary>
- </iron_bird_test_hours>
- </system_test>
- <engine_test description="Specify engine tests">
- <enable description="Switch to enable engine tests. Switch: true (engine tests on (only if new engine/s for aircraft has to be certified)) / false (engine tests off)">
- <value>true</value>
- </enable>
- <number_of_new_engines description="Number of new engine(s) to be certified">
- <value>1</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10</upper_boundary>
- </number_of_new_engines>
- <number_of_test_engines description="Number of engine for test rig (approx. 5) and flight test (approx. 1)">
- <value>6</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>100</upper_boundary>
- </number_of_test_engines>
- <rig_test>
- <test_hours description="Test hours on the engine rig within aircraft development without/with ETOPS (Extended-range Twin-engine Operations Performance Standards) hours (s.inclETOPS)">
- <value>1500</value>
- <unit>h</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>15000</upper_boundary>
- <incl_ETOPS_switch description="Adds ETOPS (Extended-range Twin-engine Operations Performance Standards) certification in test hours. Switch: true (is included) / false (is not included)">
- <value>false</value>
- </incl_ETOPS_switch>
- </test_hours>
- <max_continuous_thrust_percentage description="Percentage of test hours on the engine rig with Maximum Continuous Thrust in aircraft development">
- <value>0.1</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1</upper_boundary>
- </max_continuous_thrust_percentage>
- </rig_test>
- <flying_testbed description="Settings for the flying testbed ">
- <test_hours description="Test hours on flying testbed aircraft development">
- <value>225</value>
- <unit>h</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1000</upper_boundary>
- </test_hours>
- <flying_testbed_engines description="Information about the engine at the flying_test_bed_engines (!), not to be tested engine">
- <engine_number description="Number of engines on flying testbed (without tested engine)">
- <value>3</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>20</upper_boundary>
- </engine_number>
- <flying_testbed_fuel_consumption_per_engine description="Fuel consumption of the flying testbed engines of (one!) engine in cruise flight">
- <value>3000</value>
- <unit>kg/h</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10000</upper_boundary>
- </flying_testbed_fuel_consumption_per_engine>
- </flying_testbed_engines>
- </flying_testbed>
- </engine_test>
- <flight_test description="Settings for the flight tests">
- <test_hours description="Flight test hours in aircraft development for one / all Engine(s)-Option/s (s. incl_engine_options)">
- <value>2500</value>
- <unit>h</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10000</upper_boundary>
- <incl_engine_options description="Defines if all engine options are included in tests. Switch: true (include all engine options) / false (only one engine)">
- <value>false</value>
- </incl_engine_options>
- </test_hours>
- <number_of_flight_test_aircraft description="Number of aircraft for flight tests">
- <value>6</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10</upper_boundary>
- </number_of_flight_test_aircraft>
- </flight_test>
- </test_phase>
- </development_phase>
- <production_phase description="Settings for the calculation of the production phase">
- <production_mode description="Selects the production calculation mode. Selector: mode_0 (material mode) / mode_1 (main parts mode)">
- <value>mode_1</value>
- </production_mode>
- <primary_material_recycling_switch description="Enables primary material recycling. Switch: true (primary material will be recycled) / false (no recyling)">
- <value>true</value>
- </primary_material_recycling_switch>
- <calculate_recurring_costs_switch description="Switch for calculation of recurring costs. Switch: true (recurring costs will be calculated) / false (costs will be read from xml (old schema implemented, need to be adapted))">
- <value>true</value>
- </calculate_recurring_costs_switch>
- <number_produced_aircraft description="Number of produced aircraft per programm">
- <value>1500</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10000</upper_boundary>
- </number_produced_aircraft>
- </production_phase>
- <operating_phase description="Settings for the calculation of the production phase">
- <calculate_maintenance_costs_switch description="Switch for calulation of maintencance costs. Switch: true (maintenance material costs will be calculated) / false (costs will be read from xml (old schema implemented, need to be adapted))">
- <value>true</value>
- </calculate_maintenance_costs_switch>
- </operating_phase>
- <end_of_life_phase description="Settings for the calculation of the end of life phase">
- <distance_to_end_of_life_site description="Distance to be flown to the demolition location">
- <value>1000</value>
- <unit>NM</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10000</upper_boundary>
- </distance_to_end_of_life_site>
- </end_of_life_phase>
- </schaefer>
- </life_cycle_emissions_methods>
- </emission_calculation>
- </standard_strategy>
- </program_settings>
-```
-Additionally, the design mission taxi time is needed and read from the mission.xml:
-
-```xml
-<mission>
- <taxi_time_origin>
- <unit>s</unit>
- <value>540</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10000</upper_boundary>
- </taxi_time_origin>
- <taxi_time_destination>
- <unit>s</unit>
- <value>300</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10000</upper_boundary>
- </taxi_time_destination>
-</mission>
-```
-
-And last but not least, the emissions provided by the submodule [mission_emissions](mission_emissions) will be read from ecological_assessment XML:
-
-```xml
-<ecological_data_file>
- <mission_emissions description="Results of mission emission calculation">
- <design_mission description="Results of design mission calculation">
- <emissions description="Emissions of design mission">
- <LTO_cycle description="Emissions of landing and takeoff cycle">
- <CO2 description="LTO CO2 emissions of one design mission">
- <value>2101.394</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CO2>
- <H2O description="LTO H2O emissions of one design mission">
- <value>800.785</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </H2O>
- <SO2 description="LTO SO2 emissions of one design mission">
- <value>0.561</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </SO2>
- <SO4 description="LTO SO4 emissions of one design mission">
- <value>0.133</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </SO4>
- <HC description="LTO HC emissions of one design mission">
- <value>0.044</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </HC>
- <CH4 description="LTO CH4 emissions of one design mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CH4>
- <CO description="LTO CO emissions of one design mission">
- <value>2.855</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CO>
- <NOx description="LTO NOx emissions of one design mission">
- <value>9.911</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </NOx>
- <soot description="LTO Soot emissions of one design mission">
- <value>0.015</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </soot>
- <c_soot_LTO_max description="Maximum soot concentration during design mission LTO">
- <value>1.794e-06</value>
- <unit>1</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </c_soot_LTO_max>
- </LTO_cycle>
- <cruise description="Emissions of cruise phase">
- <CO2 description="Cruise CO2 emissions of one design mission">
- <value>53531.7</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CO2>
- <H2O description="Cruise H2O emissions of one design mission">
- <value>20399.504</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </H2O>
- <SO2 description="Cruise SO2 emissions of one design mission">
- <value>14.28</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </SO2>
- <SO4 description="Cruise SO4 emissions of one design mission">
- <value>3.4</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </SO4>
- <HC description="Cruise HC emissions of one design mission">
- <value>0.939</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </HC>
- <CH4 description="Cruise CH4 emissions of one design mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CH4>
- <CO description="Cruise CO emissions of one design mission">
- <value>32.312</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CO>
- <NOx description="Cruise NOx emissions of one design mission">
- <value>225.469</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </NOx>
- <soot description="Cruise Soot emissions of one design mission">
- <value>0.24</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </soot>
- </cruise>
- </emissions>
- </design_mission>
- <study_mission description="Results of study mission calculation">
- <emissions description="Emissions of study mission">
- <LTO_cycle description="Emissions of landing and takeoff cycle">
- <CO2 description="LTO CO2 emissions of one study mission">
- <value>2101.394</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CO2>
- <H2O description="LTO H2O emissions of one study mission">
- <value>800.785</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </H2O>
- <SO2 description="LTO SO2 emissions of one study mission">
- <value>0.561</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </SO2>
- <SO4 description="LTO SO4 emissions of one study mission">
- <value>0.133</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </SO4>
- <HC description="LTO HC emissions of one study mission">
- <value>0.044</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </HC>
- <CH4 description="LTO CH4 emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CH4>
- <CO description="LTO CO emissions of one study mission">
- <value>2.855</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CO>
- <NOx description="LTO NOx emissions of one study mission">
- <value>9.911</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </NOx>
- <soot description="LTO Soot emissions of one study mission">
- <value>0.015</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </soot>
- <c_soot_LTO_max description="Maximum soot concentration during study mission LTO">
- <value>1.794e-06</value>
- <unit>1</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </c_soot_LTO_max>
- </LTO_cycle>
- <cruise description="Emissions of cruise phase">
- <CO2 description="Cruise CO2 emissions of one study mission">
- <value>53531.7</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CO2>
- <H2O description="Cruise H2O emissions of one study mission">
- <value>20399.504</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </H2O>
- <SO2 description="Cruise SO2 emissions of one study mission">
- <value>14.28</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </SO2>
- <SO4 description="Cruise SO4 emissions of one study mission">
- <value>3.4</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </SO4>
- <HC description="Cruise HC emissions of one study mission">
- <value>0.939</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </HC>
- <CH4 description="Cruise CH4 emissions of one study mission">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CH4>
- <CO description="Cruise CO emissions of one study mission">
- <value>32.312</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </CO>
- <NOx description="Cruise NOx emissions of one study mission">
- <value>225.469</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </NOx>
- <soot description="Cruise Soot emissions of one study mission">
- <value>0.24</value>
- <unit>kg</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </soot>
- </cruise>
- </emissions>
- </study_mission>
- </mission_emissions>
-</ecological_data_file>
-```
-## Output-Data {#lca-schaefer-output}
-The Method writes data to CSV files in the *aircraft\_exchange\_file\_directory/reporting/plots/csv_files* folder containing emissions, energy demand, fuel demand and GWP100 for all processes. As described in [getting started](#getting-started), an HTML report including some plots will be generated.
diff --git a/docs/documentation/analysis/ecological_assessment/literature.bib b/docs/documentation/analysis/ecological_assessment/literature.bib
index 8ce38df..6f72d80 100644
--- a/docs/documentation/analysis/ecological_assessment/literature.bib
+++ b/docs/documentation/analysis/ecological_assessment/literature.bib
@@ -1,108 +1,102 @@
%%% BOOKS %%%
-
%%% JOURNAL ARTICLES %%%
@article{Dal11,
- Author = "Dallara, E. S. ; Kroo, I. M. and Waitz, I.A.",
- Title = {{Metric for Comparing Lifetime Average Climate Impact of Aircraft}},
- Journal = "IAAA Journal",
- Year = "2011",
- Volume = "49",
- Number = "8",
- Pages = "1600-1613"
- }
-
- @article{Kug05,
- title = {Aircraft particulate matter estimation through all phases of flight},
- author = {Kugele, A. and Jelinek, F. and Gaffal, R.},
- journal = {Eurocontrol Experimenal Centre, Br{\'e}tigny sur Orge, France},
- year = {2005}
+ author = {Dallara, E. S. and Kroo, I. M. and Waitz, I. A.},
+ title = {Metric for Comparing Lifetime Average Climate Impact of Aircraft},
+ journal = {IAAA Journal},
+ year = {2011},
+ volume = {49},
+ number = {8},
+ pages = {1600-1613}
}
-
+@article{Kug05,
+ author = {Kugele, A. and Jelinek, F. and Gaffal, R.},
+ title = {Aircraft particulate matter estimation through all phases of flight},
+ journal = {Eurocontrol Experimental Centre, Br{\'e}tigny sur Orge, France},
+ year = {2005}
+}
%%% CONFERENCE PAPERS %%%
-@inbook{Koss22,
-author = {Kristina Kossarev and Anna E. Scholz and Patrick Egerer and Mirko Hornung},
-title = {Comparison of Environmental Life Cycle Impact Assessment Methods for Future Aircraft Designs},
-booktitle = {AIAA AVIATION 2022 Forum},
-chapter = {},
-pages = {},
-doi = {10.2514/6.2022-3659},
-URL = {https://arc.aiaa.org/doi/abs/10.2514/6.2022-3659},
-eprint = {https://arc.aiaa.org/doi/pdf/10.2514/6.2022-3659},
- abstract = { View Video Presentation: https://doi.org/10.2514/6.2022-3659.vidThe environmental impact of aviation has gained increasing interest in the last two decades, resulting in investigations of novel aircraft concepts involving advanced propulsion technologies. For a holistic evaluation of the environmental footprint of these new aircraft concepts in comparison to state-of-the-art kerosene-burning aircraft, the framework of environmental life cycle assessment plays a central role. It allows compiling and analyzing the environmental impacts of a product system from "cradle-to-grave". In this work, the environmental life cycle assessment method for aircraft developed by [1] has been bug-fixed, enhanced with a new climate model, and updated from ReCiPe 2008 to ReCiPe 2016. For several future aircraft concepts, the results with the updated method were compared with the results presented by Johanning. The comparison shows that the updated ReCiPe method results in a highly increased absolute environmental impact (between +193\% and +441\%), while the relative impact of the future, alternative energy-powered aircraft concepts compared to the kerosene-powered aircraft has changed between -17.1\% and +152\% for all considered alternative energy aircraft concepts. These results demonstrate that to assess whether a future concept is more or less environmentally friendly than a reference concept, it is preferable to rely on relative results in an attempt to reduce the inherent model and parameter uncertainties. }
+@inproceedings{Koss22,
+ author = {Kossarev, Kristina and Scholz, Anna E. and Egerer, Patrick and Hornung, Mirko},
+ title = {Comparison of Environmental Life Cycle Impact Assessment Methods for Future Aircraft Designs},
+ booktitle = {AIAA AVIATION 2022 Forum},
+ year = {2022},
+ doi = {10.2514/6.2022-3659},
+ url = {https://arc.aiaa.org/doi/abs/10.2514/6.2022-3659},
+ eprint = {https://arc.aiaa.org/doi/pdf/10.2514/6.2022-3659}
}
%%% THESES %%%
@misc{Ste13,
- author = {Steinbrunn, V.},
- year = {2013},
- title = {{Bewertung von Flugzeugeentw{\"u}rfen hinsichtlich ihrer Klimawirkung}},
- howpublished = {Diplomarbeit, RWTH Aachen, Aachen, Germany}
+ author = {Steinbrunn, V.},
+ year = {2013},
+ title = {Bewertung von Flugzeugentw{"u}rfen hinsichtlich ihrer Klimawirkung},
+ howpublished = {Diplomarbeit, RWTH Aachen, Aachen, Germany}
}
@misc{Sch17,
- author = {Schaefer, K.},
- year = {2017},
- title = {{Conceptual Aircraft Design for Sustainability - Nachhaltigkeitsorientierter Flugzeugvorentwurf}},
- howpublished = {Dissertation, RWTH Aachen, Aachen, Germany}
+ author = {Schaefer, K.},
+ year = {2017},
+ title = {Conceptual Aircraft Design for Sustainability - Nachhaltigkeitsorientierter Flugzeugvorentwurf},
+ howpublished = {Dissertation, RWTH Aachen, Aachen, Germany}
}
-
%%% TECHNICAL REPORTS %%%
@techreport{Eye04,
- author = {C.J. Eyers and P. Norman and J. Middel and M. Plohr and S. Michot and K. Atkinson and R.A. Christou},
- institution = {QinetiQ},
- year = {2004},
- title = {AERO2K Global Aviation Emissions Inventories for 2002 and 2025},
- series = {QinetiQ Report},
- note = { LIDO-Berichtsjahr=2005,},
- url = {https://elib.dlr.de/1328/},
- keywords = {AERO2K Global Aviation Emissions Inventories}
+ author = {Eyers, C. J. and Norman, P. and Middel, J. and Plohr, M. and Michot, S. and Atkinson, K. and Christou, R. A.},
+ institution = {QinetiQ},
+ year = {2004},
+ title = {AERO2K Global Aviation Emissions Inventories for 2002 and 2025},
+ series = {QinetiQ Report},
+ note = {LIDO-Berichtsjahr=2005},
+ url = {https://elib.dlr.de/1328/},
+ keywords = {AERO2K Global Aviation Emissions Inventories}
}
@techreport{Nor03,
- author = {Norman, P. D., Lister, D. H., Lecht, M., Madden, P., Park, K., Penanhoat, O., et al.},
- institution = {QinetiQ},
- year = {2003},
- title = { \verb|Development of the technical basis for a New Emissions Parameter covering the whole AIRcraft operation: NEPAIR: Final Technical Report|},
- note = {Tech. Rep. NEPAIR/WP4/WPR/01 Report},
+ author = {Norman, P. D. and Lister, D. H. and Lecht, M. and Madden, P. and Park, K. and Penanhoat, O.},
+ institution = {QinetiQ},
+ year = {2003},
+ title = {Development of the technical basis for a New Emissions Parameter covering the whole AIRcraft operation: NEPAIR: Final Technical Report},
+ note = {Tech. Rep. NEPAIR/WP4/WPR/01 Report}
}
@techreport{Sch13,
- author = {Schaefer, Martin and Bartosch, Sebastian},
- institution = {DLR},
- year = {2013},
- month = {07},
- title = {Overview on fuel flow correlation methods for the calculation of NOx, CO and HC emissions and their implementation into aircraft performance software}
+ author = {Schaefer, Martin and Bartosch, Sebastian},
+ institution = {DLR},
+ year = {2013},
+ month = {07},
+ title = {Overview on fuel flow correlation methods for the calculation of NOx, CO and HC emissions and their implementation into aircraft performance software}
}
@misc{Pet05,
- author = {Petzhold, A.},
- institution = {DLR, Institut für Physik der Atmosphäre},
- year = {2005},
- title = {Particle Emissions from Aviation: Microphysics, Chemistry, and Climate Impact },
- howpublished = {Forschungsbericht 2006-02}
+ author = {Petzhold, A.},
+ institution = {DLR, Institut f{"u}r Physik der Atmosph{"a}re},
+ year = {2005},
+ title = {Particle Emissions from Aviation: Microphysics, Chemistry, and Climate Impact},
+ howpublished = {Forschungsbericht 2006-02}
}
-
%%% OTHER %%%
+
@inproceedings{Mar05,
- title={Low emission hydrogen combustors for gas turbines using lean direct injection},
- author={Marek, Cecil and Smith, Timothy and Kundu, Krishna},
- booktitle={41st AIAA/ASME/SAE/ASEE joint propulsion conference \& exhibit},
- pages={3776},
- year={2005}
+ author = {Marek, Cecil and Smith, Timothy and Kundu, Krishna},
+ title = {Low emission hydrogen combustors for gas turbines using lean direct injection},
+ booktitle = {41st AIAA/ASME/SAE/ASEE joint propulsion conference \& exhibit},
+ pages = {3776},
+ year = {2005}
}
@inproceedings{Lam12,
- title={Aircraft cost model for preliminary design synthesis},
- author={Lammering, Tim and Franz, Katharina and Risse, Kristof and Hoernschemeyer, Ralf and Stumpf, Eike},
- booktitle={50th AIAA Aerospace Sciences Meeting including the New Horizons Forum and Aerospace Exposition},
- pages={686},
- year={2012}
-}
+ author = {Lammering, Tim and Franz, Katharina and Risse, Kristof and Hoernschemeyer, Ralf and Stumpf, Eike},
+ title = {Aircraft cost model for preliminary design synthesis},
+ booktitle = {50th AIAA Aerospace Sciences Meeting including the New Horizons Forum and Aerospace Exposition},
+ pages = {686},
+ year = {2012}
+}
\ No newline at end of file
diff --git a/docs/documentation/analysis/ecological_assessment/mission_emissions.md b/docs/documentation/analysis/ecological_assessment/mission_emissions.md
deleted file mode 100644
index 1871d52..0000000
--- a/docs/documentation/analysis/ecological_assessment/mission_emissions.md
+++ /dev/null
@@ -1,194 +0,0 @@
-# mission_emissions {#mission-emissions}
-The submodule _mission_emissions_ is the only part of _ecological\_assessment_ that will always be executed. It is handled via the class `Mission` and provides various options to calculate the emissions of kerosene or hydrogen-burning engines during a mission.
-
-## General principles {#mission-emissions-generalprinciples}
-The following steps are executed within the mission class:
-- `get_mission_data`, `write_emissions_path_csv`, and `get_engine_thermodynamics_LTO`: Data from the `mission.csv` file is imported, engine data for every mission step is determined and saved in a CSV file, and the engine thermodynamics during the landing and takeoff phase according to ICAO definition are calculated.
-- Emission calculation: Depending on the defined engine carrier, the emissions will be calculated for every mission step.
- - Kerosene:
- - The emissions of CO2, H2O, SO2, and SO4 are considered to be proportional to the fuel flow. Therefore, they are calculated via $ m_{emission} = EI * m_{fuel}$, with
- - $ m_{emission}$: emission mass $[kg]$
- - $ EI $: emission index $[\frac{kg_{emission}}{kg_{fuel}}]$
- - $ m_{fuel} $: fuel mass $[kg]$
- - All other emissions are considered to be non-proportional. For NOx emissions, there are a P3T3 Method \cite Nor03, Boeing Fuel Flow Method 2 \cite Sch13, and the calculation based on data generated by GasTurb available. For HC as well as CO emissions, the DLR Omega method and Boeing Fuel Flow Method 2 \cite Sch13 are implemented. Additionally, there is the option to calculate the landing and takeoff cycle emissions based on constants provided by ICAO. Soot emissions can be determined via a DLR correlation based on ICAO smoke numbers or a correlation by R.B. Whyte \cite Kug05. Alternatively, it can be assumed to be proportional to the consumed fuel.
- - Hydrogen: Only H2O and NOx emissions are produced.
- - H2O is assumed to be proportional to the fuel flow.
- - For NOx emissions, the emissions of kerosene-burning engines are calculated via the P3T3 method, and a correction factor is used to derive the hydrogen-burning emissions \cite Koss22. You can choose between the calculation of the correction factor and the use of constant emission indices, which were determined in \cite Koss22 for one engine type. As the determination of NOx emissions during hydrogen burning is subject to great uncertainty, the low-fidelity method of using constants is both used as the default method and also implemented as a fallback method if the calculation of a correction factor fails.
-
-## Input Data {#mission-emissions-input}
-For the mission emission calculation, the following parameters are needed in the `aircraft_exchange_file`:
-```xml
-<aircraft_exchange_file>
- <requirements_and_specifications>
- <general>
- <type>
- <value>CeRAS</value>
- </type>
- <model>
- <value>SMR-2020</value>
- </model>
- </general>
- <design_specification>
- <configuration>
- <configuration_type>
- <value>tube_and_wing</value>
- </configuration_type>
- <aerodynamic_technologies>
- <value>false</value>
- </aerodynamic_technologies>
- </configuration>
- <energy_carriers>
- <energy_carrier ID="0">
- <type>
- <value>kerosene</value>
- </type>
- </energy_carrier>
- </energy_carriers>
- <assessment_scenario>
- <flights_per_year>
- <unit>1</unit>
- <value>2227</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>4000</upper_boundary>
- </flights_per_year>
- </assessment_scenario>
- </design_specification>
- <requirements_and_specifications>
-<aircraft_exchange_file>
-```
-
-In the `ecological_assessment_conf.xml`, next to the control settings block, the following program settings are needed:
-```xml
-<program_settings>
- <strategy_selector>
- <value>STANDARD</value>
- </strategy_selector>
- <standard_strategy>
- <emission_calculation>
- <mission_emissions>
- <emission_methods>
- <kerosene>
- <HC_method_selector>
- <value>mode_0</value>
- </HC_method_selector>
- <CO_method_selector>
- <value>mode_0</value>
- </CO_method_selector>
- <NOx_method_selector>
- <value>mode_0</value>
- </NOx_method_selector>
- <soot_method_selector>
- <value>mode_0</value>
- </soot_method_selector>
- </kerosene>
- <hydrogen_combustion>
- <NOx_method_selector>
- <value>mode_0</value>
- </NOx_method_selector>
- </hydrogen_combustion>
- </emission_methods>
- <relative_humidity>
- <unit>1</unit>
- <value>0.6</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1</upper_boundary>
- </relative_humidity>
- </mission_emissions>
- </emission_calculation>
- <duration_operation>
- <unit>a</unit>
- <value>25</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>50</upper_boundary>
- </duration_operation>
- </standard_strategy>
-</program_settings>
-```
-
-As the engine library will be used, you can check the documentation page of the library to get information about input files. From the `engine_data_file`, the following parameters are needed:
-```xml
-<EngineDataFile>
- <EngineDesignCondition>
- <flightAltitude>35000</flightAltitude>
- <flightMachNumber>0.8</flightMachNumber>
- </EngineDesignCondition>
- <Deck>
- <WFToP3min>45</WFToP3min>
- <WFToP3max_MTO>101.83</WFToP3max_MTO>
- <WFToP3max_MCT>98.74</WFToP3max_MCT>
- <TempMax_MTO>848.69</TempMax_MTO>
- <TempMax_MCT>772.35</TempMax_MCT>
- <N2max>1.034</N2max>
- <NfractionClimbRating>0.97</NfractionClimbRating>
- <NfractionCruiseRating>0.875</NfractionCruiseRating>
- <RelBleedMax>0.3</RelBleedMax>
- <ShaftPowerExtractionMax>150</ShaftPowerExtractionMax>
- <UnscaledSLST>110.3126953</UnscaledSLST>
- </Deck>
- <EmissionFactors>
- <NOxFactor>32</NOxFactor>
- </EmissionFactors>
- <ICAOEngineData>
- <LTOFuelFlow>
- <Taxi>0.128</Taxi>
- <Takeoff>1.053</Takeoff>
- <ClimbOut>0.88</ClimbOut>
- <Approach>0.319</Approach>
- </LTOFuelFlow>
- <LTOEmissions>
- <HCFactor>
- <Taxi>0.105e-3</Taxi>
- <Approach>0.061e-3</Approach>
- <ClimbOut>0.041e-3</ClimbOut>
- <Takeoff>0.041e-3</Takeoff>
- </HCFactor>
- <COFactor>
- <Taxi>12.43e-3</Taxi>
- <Approach>2.44e-3</Approach>
- <ClimbOut>0.62e-3</ClimbOut>
- <Takeoff>0.53e-3</Takeoff>
- </COFactor>
- <NOxFactor>
- <Taxi>4.7e-3</Taxi>
- <Approach>8.9e-3</Approach>
- <ClimbOut>22.3e-3</ClimbOut>
- <Takeoff>26.5e-3</Takeoff>
- </NOxFactor>
- <SNFactor>
- <Taxi>2.6</Taxi>
- <Takeoff>5.2</Takeoff>
- <ClimbOut>7.2</ClimbOut>
- <Approach>4.2</Approach>
- </SNFactor>
- </LTOEmissions>
- </ICAOEngineData>
-</EngineDataFile>
-```
-
-Also, some data from `mission.xml` will be read:
-```xml
-<mission>
- <taxi_time_origin>
- <unit>s</unit>
- <value>540</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10000</upper_boundary>
- </taxi_time_origin>
- <taxi_time_destination>
- <unit>s</unit>
- <value>300</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10000</upper_boundary>
- </taxi_time_destination>
- <range>
- <unit>m</unit>
- <value>4630000</value>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>100000000</upper_boundary>
- </range>
-</mission>
-```
-And last but not least, you need to provide the `mission.csv` file written by the UNICADO mission module and located in _aircraft\_exchange\_file\_directory/missionData_.
-
-## Output-Data {#mission-emissions-output}
-The central output of the mission submodule is the `ecological_assessment_results_file.xml` which you will find in the *aircraft\_exchange\_file\_directory/reporting/report_xml*. It contains all calculated emission masses. Additionally, there is a CSV file in the folder *aircraft_exchange_file_directory/reporting/plots/csv_files/* with mission and engine data for every mission step. As described in [getting started](#getting-started), an HTML report including some plots will be generated.
diff --git a/docs/documentation/analysis/ecological_assessment/softwarearchitecture.md b/docs/documentation/analysis/ecological_assessment/software-architecture.md
similarity index 100%
rename from docs/documentation/analysis/ecological_assessment/softwarearchitecture.md
rename to docs/documentation/analysis/ecological_assessment/software-architecture.md
diff --git a/docs/documentation/analysis/ecological_assessment/usage.md b/docs/documentation/analysis/ecological_assessment/usage.md
new file mode 100644
index 0000000..92e9011
--- /dev/null
+++ b/docs/documentation/analysis/ecological_assessment/usage.md
@@ -0,0 +1,137 @@
+# Usage of the ecological_assessment tool {#usage}
+You have carefully read the [basic-concepts](basic-concepts.md) and feel ready to assess your first aircraft? Great! :fire: This guide will show you step by step the basic usage of the _ecological\_assessment_ tool.
+
+## Prerequisites
+1. It is assumed that you have the `UNICADO Package` installed, including the executables and UNICADO libraries. If you are a developer, you need to build the tool first (see [build instructions on the UNICADO website](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/build/cpp/)).
+2. Fill out the configuration file.
+ - change at least in `control_settings`:
+ - `aircraft_exchange_file_name` and `aircraft_exchange_file_directory` to your respective settings
+ - set `console_output` at least to `mode_1`
+ - set `plot_output` to false (or define `inkscape_path` and `gnuplot_path`)
+ - define in the `program_settings` which submodules you would like to execute
+ - all other parameters can be left at default values
+3. You need to provide all necessary input data. What is necessary depends on the chosen methods (or executed submodule). In general, you need a project environment as described in [Seperate Tool Execution](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/tutorials/seperate-tool-execution/)(here for example with a CSMR-2020 aircraft exchange file):
+
+<pre class='mermaid'>
+graph LR
+ A[project environment] --> B[ecological_assessment]
+ B --> B1[ecological_assessment.exe]
+ B --> B2[ecological_assessment_config.xml]
+ A --> C[gnuplot]
+ C --> C1[gnuplot.exe]
+ C --> C2[...]
+ A --> D[inkscape]
+ D --> D1[inkscape.exe]
+ D --> D2[...]
+ A --> E[projects]
+ E --> E1[CSMR]
+ E1 --> E2[CSMR-2020]
+ E2 --> E3[CSMR-2020.xml]
+ A --> F[databases]
+ F --> F1[engine]
+ A --> G[libs]
+</pre>
+
+If you followed step 1, you will automatically have this environment. But make sure, that the aircraft exchange file includes all nodes defined in the input data sections of the submodule you would like to execute (remember: you'll find the information [here](basic-concepts.md)). If the tool is executed via the workflow, all data will be available anyway.
+
+## Tool execution
+If you have prepared everything, you can open a terminal and run *ecological_assessment.exe*. You will see output in the console window. If you chose `mode_1` for console output, you'll only be informed about the ongoing calculation step. For more information, choose a higher mode. At `mode_1`, you will get following output:
+```xml
+*******************************************************************************
+27.01.2025 14:33:32 - Start ecological_assessment
+27.01.2025 14:33:33 - [MODULE RUNTIMEINFO] - ecological_assessment
+27.01.2025 14:33:33 - [CONSOLE ] - [ON]
+27.01.2025 14:33:33 - [LOG ] - [ON]
+27.01.2025 14:33:33 - [PLOT ] - [ON]
+27.01.2025 14:33:33 - [COPY ] - [ON]
+27.01.2025 14:33:33 - [DELETE] - [ON]
+27.01.2025 14:33:33 - [REPORT ] - [ON]
+27.01.2025 14:33:33 - [TEX ] - [ON]
+27.01.2025 14:33:33 - [INFOFILES] - [OFF]
+27.01.2025 14:33:33 - [GNUPLOT]
+27.01.2025 14:33:33 - [PATH ] - ../gnuplot
+27.01.2025 14:33:33 - [FILENAME] -
+27.01.2025 14:33:33 - [INKSCAPE]
+27.01.2025 14:33:33 - [PATH ] - ../inkscape
+27.01.2025 14:33:33 - [FILENAME] -
+27.01.2025 14:33:33 - [LOGFILE]
+27.01.2025 14:33:33 - [PATH ] -
+27.01.2025 14:33:33 - [FILENAME] - ecological_assessment.log
+27.01.2025 14:33:33 - [IO/ACXML]
+27.01.2025 14:33:33 - [PATH ] - ../projects
+27.01.2025 14:33:33 - [FILENAME] - csmr-2020.xml
+27.01.2025 14:33:33 - [MODCONFIG]
+27.01.2025 14:33:33 - [PATH ] - .
+27.01.2025 14:33:33 - [FILENAME] - ecological_assessment_conf.xml
+27.01.2025 14:33:33 - Checking directory... [REPORT]
+27.01.2025 14:33:33 - Checking directory... [TEX]
+27.01.2025 14:33:33 - Checking directory... [HTML]
+27.01.2025 14:33:33 - Checking directory... [PLOT]
+27.01.2025 14:33:33 - Checking directory... [CSVFILES]
+27.01.2025 14:33:33 - Checking directory... [CSVFILESTOOL]
+27.01.2025 14:33:33 - Creating directory... [CSVFILESTOOL]
+27.01.2025 14:33:33 - Checking directory... [PLOTFILES]
+27.01.2025 14:33:33 - Checking directory... [PLOTFILESTOOL]
+27.01.2025 14:33:33 - Creating directory... [PLOTFILESTOOL]
+27.01.2025 14:33:33 - Checking directory... [LOGFILES]
+```
+To this point, the module is in the top level stage and creates folders and checks the configuration file settings from the control block. Here you can see some common information.
+
+Then, the standard strategy is initialized. You can see, which methods were chosen in the configuration file:
+```xml
+27.01.2025 14:33:33 - Initialize standard strategy
+27.01.2025 14:33:33 - Method SCHAEFER will be used for life cycle emission calculation
+27.01.2025 14:33:33 - Method DALLARA will be used for climate model
+27.01.2025 14:33:33 - Method SCHAEFER will be used for air quality calculation
+```
+
+Afterwards, the strategy is run. Here, the calculation routines are executed. You can track, which method is currently running.
+```xml
+27.01.2025 14:33:33 - Run standard strategy
+27.01.2025 14:33:34 - Calculation of design mission emissions
+27.01.2025 14:33:52 - Update ecological_assessment_results.xml
+27.01.2025 14:33:53 - Calculation of study mission emissions
+27.01.2025 14:34:06 - Update ecological_assessment_results.xml
+27.01.2025 14:34:06 - Calculation of life cycle emissions
+27.01.2025 14:34:07 - Calculation of production phase...
+27.01.2025 14:34:07 - Calculation of operation phase...
+27.01.2025 14:34:07 - Calculation of end of life phase...
+27.01.2025 14:34:07 - Calculation of development phase...
+27.01.2025 14:34:07 - Update ecological_assessment_results.xml
+27.01.2025 14:34:07 - Calculation of climate impact
+27.01.2025 14:34:07 - Calculation of air quality index
+```
+After successful calculation, the aircraft exchange file will be updated, plots generated and the reports written. Finally, the module execution is finished.
+```xml
+27.01.2025 14:34:08 - Update csmr-2020.xml
+27.01.2025 14:34:08 - Generate plots
+27.01.2025 14:34:08 - Generate study mission plots
+27.01.2025 14:34:16 - Generate design mission plots
+27.01.2025 14:34:23 - Generate SCHAEFER emissions plots
+27.01.2025 14:34:23 - Generate DALLARA plots
+27.01.2025 14:34:25 - Write reports
+27.01.2025 14:34:25 - Write mission report body
+27.01.2025 14:34:25 - Write SCHAEFER emissions report body
+27.01.2025 14:34:25 - Write DALLARA climate report body
+27.01.2025 14:34:25 - Write SCHAEFER air quality report body
+27.01.2025 14:34:25 - CSS code written to style.css successfully.
+27.01.2025 14:34:25 - Finish ecological_assessment
+```
+You will find a `.log` file within the directory of the executable and an HTML report in the directory of `aircraft_exchange_file_directory/reporting/reportHTML`. Depending on your chosen methods, results are saved in
+
+- `/aircraft_exchange_file/assessment/average_temperature_response`
+- and/or in the files you'll find in the `aircraft_exchange_file_directory/reporting/plots/` directory
+- and/or in the files you'll find in the `aircraft_exchange_file_directory/reporting/plots/csv_files` directory.
+
+Be aware of the files' timestamp as there could be leftovers of earlier program executions!
+
+## Changing user input
+If you want to adapt the tool's execution, you can modify the parameters within the configuration file. There, you can enable or disable specific aspects of the ecological assessment and select the methods to be used for the calculations. At the [basic concepts](basic-concepts.md), you can check which parameters are available. Start with changing only one parameter at once, so you can track the influence of this parameter!
+
+## Troubleshooting
+If something does not work as expected:
+
+- Check the log file for error messages or warnings. Most probably it will tell you what went wrong.
+- Make sure you have all the paths set up correctly and the specified elements exist.
+- Check your settings in the config file. Maybe you've accidentally disabled an output which you expect to see now?
+
diff --git a/mkdocs.yml b/mkdocs.yml
index 384e575..88f0e3f 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -151,7 +151,7 @@ plugins:
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
-
+
- glightbox # Plugin for lightbox-style image and content viewing.
# === Theme configuration ===
@@ -194,9 +194,9 @@ nav: # Customizes the main navigation struc
- Documentation: # Top-level item for documentation.
- Overview: documentation/overview.md # Overview of modules.
- Aircraft Design:
- - Sizing:
+ - Sizing:
- Modules: documentation/sizing.md # Link to aircraft sizing documentation.
- - Initial Sizing:
+ - Initial Sizing:
- Introduction: documentation/sizing/initial_sizing/index.md
- Getting Started: documentation/sizing/initial_sizing/getting-started.md
- Methods: documentation/sizing/initial_sizing/initialSizing.md
@@ -206,7 +206,7 @@ nav: # Customizes the main navigation struc
- initial_sizing/namespaces.md
- initial_sizing/files.md
- initial_sizing/functions.md
- - Fuselage Design:
+ - Fuselage Design:
- Introduction: documentation/sizing/fuselage_design/index.md
- Getting Started: documentation/sizing/fuselage_design/getting-started.md
- Design Method: documentation/sizing/fuselage_design/design_method.md
@@ -223,7 +223,7 @@ nav: # Customizes the main navigation struc
- wing_design/namespaces.md
- wing_design/files.md
- wing_design/functions.md
- - Empennage Design:
+ - Empennage Design:
- Introduction: documentation/sizing/empennage_design/index.md
- Getting Started: documentation/sizing/empennage_design/getting-started.md
- Basic Concepts: documentation/sizing/empennage_design/basic-concepts.md
@@ -233,7 +233,7 @@ nav: # Customizes the main navigation struc
- empennage_design/namespaces.md
- empennage_design/files.md
- empennage_design/functions.md
- - Tank Design:
+ - Tank Design:
- Introduction: documentation/sizing/tank_design/index.md
- Getting Started: documentation/sizing/tank_design/getting-started.md
- Design Method: documentation/sizing/tank_design/tank_design_method.md
@@ -256,14 +256,14 @@ nav: # Customizes the main navigation struc
- propulsion_design/namespaces.md
- propulsion_design/files.md
- propulsion_design/functions.md
- - Landing Gear Design:
+ - Landing Gear Design:
- Introduction: documentation/sizing/landing_gear_design/index.md
- Getting Started: documentation/sizing/landing_gear_design/getting-started.md
- Design Method: documentation/sizing/landing_gear_design/design_method.md
- Run your First Design: documentation/sizing/landing_gear_design/run_your_first_design.md
- Software Architecture: documentation/sizing/landing_gear_design/software_architecture.md
# - API Reference: # TODO define for Python
- - Systems Design:
+ - Systems Design:
- Introduction: documentation/sizing/systems_design/index.md
- Getting Started: documentation/sizing/systems_design/getting-started.md
- Implemented Models: documentation/sizing/systems_design/systems.md
@@ -273,7 +273,7 @@ nav: # Customizes the main navigation struc
- systems_design/namespaces.md
- systems_design/files.md
- systems_design/functions.md
- - Analysis:
+ - Analysis:
- Modules: documentation/analysis.md # Link to analysis module page.
- Weight and Balance Analysis:
- Introduction: documentation/analysis/weight_and_balance_analysis/index.md
@@ -288,7 +288,9 @@ nav: # Customizes the main navigation struc
# - API Reference: # TODO define for Python
- Ecological Assessment:
- Introduction: documentation/analysis/ecological_assessment/index.md
- - Getting Started: documentation/analysis/ecological_assessment/getting-started.md
+ - Basic Concepts: documentation/analysis/ecological_assessment/basic-concepts.md
+ - Module Usage: documentation/analysis/ecological_assessment/usage.md
+ - Software Architecture: documentation/analysis/ecological_assessment/software-architecture.md
- Changelog: documentation/analysis/ecological_assessment/changelog.md
- API Reference:
- ecological_assessment/classes.md
@@ -310,7 +312,7 @@ nav: # Customizes the main navigation struc
- Workflow: 'workflow.md' # Link to the workflow page.
- Get Involved:
- Developer Guide: get-involved/developer-installation.md # Top-level item for contributions and development.
- - Build Instructions:
+ - Build Instructions:
- Prerequisites:
- Windows: get-involved/build-environment/windows.md
- Linux: get-involved/build-environment/linux.md
--
GitLab
From 1be825de03c9b801c7350b644576c720381fec2c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9CKatrinBistreck=E2=80=9D?=
<“katrin.bistreck@tuhh.de”>
Date: Thu, 30 Jan 2025 18:25:25 +0100
Subject: [PATCH 2/4] started software architecture
---
.../software-architecture.md | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/docs/documentation/analysis/ecological_assessment/software-architecture.md b/docs/documentation/analysis/ecological_assessment/software-architecture.md
index 07956ba..30d6486 100644
--- a/docs/documentation/analysis/ecological_assessment/software-architecture.md
+++ b/docs/documentation/analysis/ecological_assessment/software-architecture.md
@@ -2,5 +2,19 @@
At the highest level, the `main_ecological_assessment.cpp` calls the function `execute()` of the class `EcologicalAssessment`, which inherits from the class `Module` (available in the library **moduleBasics**). `EcologicalAssessment` provides access to defined strategies. It will run the functions `initialize`, `run`, `update`, `report` and `save` of the strategy (inherited from the `Module` class in **moduleBasics**). Additionally, the `save` function will save and close the aircraft XML file, as well as close the configuration file.
-Currently, only one strategy (called STANDARD) is implemented. Here you can find more information about it: @subpage standard-strategy
+If you're interested in developing this module, reading this chapter could be helpful. It provides some insights into the software structure and shall help you to find a way around :flashlight:
+
+As you have for sure carefully read our (developer guide)[https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/get-involved/developer-installation/], you already know everything about the modularized structure of the UNICADO and the top, intermediate and low level of its modules. So, here is how the *ecological_assessment* tool looks like:
+
+- On the top level, nothing fancy happens. Within the src directory, you will find the `main_ecological_assessment.cpp` which executes the module and the `ecolocical_assessment.cpp`/`ecolocical_assessment.h`, where the class EcologicalAssessment, which is inherited from the class Module, is defined. Therefor, it will run the functions `initialize`, `run`, `update`, `report` and `save` of the strategy. The save function will save and close the aircraft XML file and close the configuration file. In the class definition, you the RuntimeIO pointer is
+
+- The intermediate level is structured by the implemented strategies.
+
+- On the low level, you'll find all in (basic concepts)[basic-concepts.md] described methods. The folder structure is like the module structure. So the *standard_strategy* is subdivided into *emission_calculation* and *impact_calulation*.
+
+All submodules have a class _IOData_, which contains all data from acXML and functions to read or write the data. Additionally, it has a member _configuration_, which provides access to configuration file data. The submodules are executed via the function `run`, which is called by the `StandardStrategy`. The `run` function shall call functions to
+
+ - initialize the data,
+ - perform the calculation routines
+ - and update the `ecological_assessment_results.xml` (in case there are results that are needed by other parts of *ecological_assessment*).
--
GitLab
From eb91ff8b40208a261a3517f7efb3289346c072d4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9CKatrinBistreck=E2=80=9D?=
<“katrin.bistreck@tuhh.de”>
Date: Fri, 31 Jan 2025 12:27:06 +0100
Subject: [PATCH 3/4] Complete software architecture + some usage changes
---
.../software-architecture.md | 13 +++----
.../analysis/ecological_assessment/usage.md | 39 ++++++++-----------
2 files changed, 22 insertions(+), 30 deletions(-)
diff --git a/docs/documentation/analysis/ecological_assessment/software-architecture.md b/docs/documentation/analysis/ecological_assessment/software-architecture.md
index 30d6486..3b6c296 100644
--- a/docs/documentation/analysis/ecological_assessment/software-architecture.md
+++ b/docs/documentation/analysis/ecological_assessment/software-architecture.md
@@ -1,19 +1,16 @@
# Software Architecture {#softwarearchitecture}
-At the highest level, the `main_ecological_assessment.cpp` calls the function `execute()` of the class `EcologicalAssessment`, which inherits from the class `Module` (available in the library **moduleBasics**). `EcologicalAssessment` provides access to defined strategies. It will run the functions `initialize`, `run`, `update`, `report` and `save` of the strategy (inherited from the `Module` class in **moduleBasics**). Additionally, the `save` function will save and close the aircraft XML file, as well as close the configuration file.
-
-
-If you're interested in developing this module, reading this chapter could be helpful. It provides some insights into the software structure and shall help you to find a way around :flashlight:
+If you're interested in developing this module, reading this chapter could be helpful. It provides some insights into the software (folder) structure and shall help you to find a way around :flashlight:
As you have for sure carefully read our (developer guide)[https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/get-involved/developer-installation/], you already know everything about the modularized structure of the UNICADO and the top, intermediate and low level of its modules. So, here is how the *ecological_assessment* tool looks like:
-- On the top level, nothing fancy happens. Within the src directory, you will find the `main_ecological_assessment.cpp` which executes the module and the `ecolocical_assessment.cpp`/`ecolocical_assessment.h`, where the class EcologicalAssessment, which is inherited from the class Module, is defined. Therefor, it will run the functions `initialize`, `run`, `update`, `report` and `save` of the strategy. The save function will save and close the aircraft XML file and close the configuration file. In the class definition, you the RuntimeIO pointer is
+- On the top level, nothing fancy happens. Within the *src* directory, you will find the `main_ecological_assessment.cpp` which executes the module and the `ecolocical_assessment.cpp`/`ecolocical_assessment.h`, where the class EcologicalAssessment, which is inherited from the class Module, is defined. Therefor, it will run the functions `initialize`, `run`, `update`, `report` and `save` of the strategy. The save function will save and close the aircraft XML file and close the configuration file. In the class definition, you the RuntimeIO pointer is
-- The intermediate level is structured by the implemented strategies.
+- The intermediate level is structured by the implemented strategies. This section is a short one: there is only one strategy implemented in the module. It is called **STANDARD** and provides access to all the submodules.
-- On the low level, you'll find all in (basic concepts)[basic-concepts.md] described methods. The folder structure is like the module structure. So the *standard_strategy* is subdivided into *emission_calculation* and *impact_calulation*.
+- On the low level, you'll find all in (basic concepts)[basic-concepts.md] described methods. The folder structure is like the module structure. So the *standard_strategy* is subdivided into *emission_calculation* and *impact_calulation*. In the directory, there is the class StandardStrategy, which contains the definition of `initialize`, `run`, `update`, `report` and `save`. The class can be seen as the coordinator of the submodules: in `initialize` it reads from the configuration file, which submodules shall be executed and prepares the `ecological_assessment_results.xml`. In `run`, the submodule's `run` functions are executed. In `update`, the aircraft exchange file will be updated and `report` calls the both the plotting and report functions of all executed submodules and generates the overall module reports. In a last step, `save` will save the `ecological_assessment_results.xml`. The *standard_strategy* directory additionally contains teh definition of emissionsClass, which provides a collection all emissions calculated by the module. Within the folder *emission_calculation* there are directories for *mission_emissions* and *life_cycle_emissions* which contain the corresponding methods. In addition, the class ecoDatabase offers access to database data used for calculations. The directory *impact_calculation* contains all methods to determine the impact of the emissions.
-All submodules have a class _IOData_, which contains all data from acXML and functions to read or write the data. Additionally, it has a member _configuration_, which provides access to configuration file data. The submodules are executed via the function `run`, which is called by the `StandardStrategy`. The `run` function shall call functions to
+All submodules have a class _IOData_, which contains all data from acXML and functions to read or write the data. Additionally, the class has a member _configuration_, which provides access to configuration file data. The `run` function of the submodules shall call functions to
- initialize the data,
- perform the calculation routines
diff --git a/docs/documentation/analysis/ecological_assessment/usage.md b/docs/documentation/analysis/ecological_assessment/usage.md
index 92e9011..5f34185 100644
--- a/docs/documentation/analysis/ecological_assessment/usage.md
+++ b/docs/documentation/analysis/ecological_assessment/usage.md
@@ -3,36 +3,31 @@ You have carefully read the [basic-concepts](basic-concepts.md) and feel ready t
## Prerequisites
1. It is assumed that you have the `UNICADO Package` installed, including the executables and UNICADO libraries. If you are a developer, you need to build the tool first (see [build instructions on the UNICADO website](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/build/cpp/)).
-2. Fill out the configuration file.
+2. Fill out the configuration file `ecological_assessment_config.xml`.
- change at least in `control_settings`:
- `aircraft_exchange_file_name` and `aircraft_exchange_file_directory` to your respective settings
- set `console_output` at least to `mode_1`
- set `plot_output` to false (or define `inkscape_path` and `gnuplot_path`)
- define in the `program_settings` which submodules you would like to execute
- all other parameters can be left at default values
-3. You need to provide all necessary input data. What is necessary depends on the chosen methods (or executed submodule). In general, you need a project environment as described in [Seperate Tool Execution](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/tutorials/seperate-tool-execution/)(here for example with a CSMR-2020 aircraft exchange file):
+3. You need to provide all necessary input data. What is necessary depends on the chosen methods (or executed submodule). In general, you need a (shortened) project environment as described in [Seperate Tool Execution](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/tutorials/seperate-tool-execution/). The aircraft exchange file need to located at the path you defined in the configuration file. Here is an example with a CSMR-2020 in the projects directory:
-<pre class='mermaid'>
-graph LR
- A[project environment] --> B[ecological_assessment]
- B --> B1[ecological_assessment.exe]
- B --> B2[ecological_assessment_config.xml]
- A --> C[gnuplot]
- C --> C1[gnuplot.exe]
- C --> C2[...]
- A --> D[inkscape]
- D --> D1[inkscape.exe]
- D --> D2[...]
- A --> E[projects]
- E --> E1[CSMR]
- E1 --> E2[CSMR-2020]
- E2 --> E3[CSMR-2020.xml]
- A --> F[databases]
- F --> F1[engine]
- A --> G[libs]
-</pre>
-If you followed step 1, you will automatically have this environment. But make sure, that the aircraft exchange file includes all nodes defined in the input data sections of the submodule you would like to execute (remember: you'll find the information [here](basic-concepts.md)). If the tool is executed via the workflow, all data will be available anyway.
+ ```
+ project environment
+ ├── ecological_assessment/
+ │ ├── ecological_assessment.exe
+ │ └── ecological_assessment_config.xml
+ ├── projects/
+ │ └── CSMR/
+ │ └──CSMR-2020
+ │ └── CSMR-2020.xml
+ ├── databases/
+ │ └── engine/
+ └── libs/
+ ```
+
+ If you used the UNICADO installer, you will automatically have this environment in your UNICADOworkflow directory. But make sure, that the aircraft exchange file includes all nodes defined in the input data sections of the submodule you would like to execute (remember: you'll find the information [here](basic-concepts.md)). If the tool is executed via the workflow, all data will be available anyway.
## Tool execution
If you have prepared everything, you can open a terminal and run *ecological_assessment.exe*. You will see output in the console window. If you chose `mode_1` for console output, you'll only be informed about the ongoing calculation step. For more information, choose a higher mode. At `mode_1`, you will get following output:
--
GitLab
From b2b01a12c4f684833b1811ef9218e5e7840aa15e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9CKatrinBistreck=E2=80=9D?=
<“katrin.bistreck@tuhh.de”>
Date: Mon, 3 Feb 2025 17:16:26 +0100
Subject: [PATCH 4/4] changes according to review
---
.../ecological_assessment/basic-concepts.md | 24 ++++++++++++-------
.../analysis/ecological_assessment/index.md | 6 ++---
.../software-architecture.md | 6 ++---
3 files changed, 21 insertions(+), 15 deletions(-)
diff --git a/docs/documentation/analysis/ecological_assessment/basic-concepts.md b/docs/documentation/analysis/ecological_assessment/basic-concepts.md
index d5e6424..cfef150 100644
--- a/docs/documentation/analysis/ecological_assessment/basic-concepts.md
+++ b/docs/documentation/analysis/ecological_assessment/basic-concepts.md
@@ -60,7 +60,7 @@ All other emissions are considered to be non-proportional and are calculated wit
- Soot emissions can be determined via a DLR correlation based on ICAO smoke numbers or a correlation by R.B. Whyte \cite Kug05. Alternatively, it can be assumed to be proportional to the consumed fuel.
#### Hydrogen Combustion Emissions
-When hydrogen is burned in a engine, only H2O and NOx emissions are produced. H2O is again assumed to be proportional to the fuel flow. For NOx emissions, the emissions of kerosene-burning engines are calculated via the P3T3 method and a correction factor is used to derive the hydrogen-burning emissions \cite Koss22. You can choose between the calculation of the correction factor and the use of constant emission indices, which were determined in \cite Koss22 for one engine type. As the determination of NOx emissions when burning hydrogen is subject to great uncertainty, the low-fidelity method of using constants is both used as the default method and also implemented as a fallback method if the calculation of a correction factor fails. Following constant NOx emission indices are used:
+When hydrogen is burned in an engine, only H2O and NOx emissions are produced. H2O is again assumed to be proportional to the fuel flow. For NOx emissions, there are two methods implemented. As the determination of NOx emissions when burning hydrogen is subject to great uncertainty, a the low-fidelity method of using constant emission indices for different flight phases is the default method. The emission indices were determined in \cite Koss22 for one engine type and are listed in this table:
Phase | EI [g/kg]|
--------|----------|
@@ -70,6 +70,11 @@ Climb | 6.17 |
Cruise | 3.14 |
Approach| 2.4 |
+Alternatively, you can choose to follow the method describes in \cite Koss22 and calculate the emission index in every mission step. For that, the emissions of kerosene-burning engines are calculated via the P3T3 method and a correction factor is used to derive the emissions due to hydrogen combustion. If the calculation of a correction factor fails, the first method is used as a fallback method.
+
+
+
+
### Input data {#mission-emissions-input}
For the mission emission calculation (including used libraries), the following parameters are needed in the `aircraft_exchange_file`:
@@ -135,19 +140,20 @@ $ Em_{energy} = Em_{energy}^* \cdot E $
$ Em_{fuel} = Em_{fuel}^* \cdot f + Em_{com}$
-$ Em_{mat} = Em_{mat}^* \cdot mat [kg] $
+$ Em_{mat} = Em_{mat}^* \cdot m_{mat} $
with
- $ Em_{energy} $: Emissions due to energy production (both electric and heat energy) [kg]
- $ Em_{fuel} $: Emissions due to fuel production and combustion [kg]
- $ Em_{mat} $: Emissions due to material extraction [kg]
-- $ Em_{energy}^* $: Energy specific emissions [kg/MJ]
-- $ Em_{fuel}^* $: Fuel specific production emissions [kg/kg]
-- $ Em_{mat}^* $: Material specific extraction emissions [kg/kg]
+- $ Em_{com} $: Emissions due to fuel combustion [kg]
+- $ Em_{energy}^* $: Specific energy production emissions [kg/MJ]
+- $ Em_{fuel}^* $: Specific fuel production emissions [kg/kg]
+- $ Em_{mat}^* $: Specific material extraction emissions [kg/kg]
- $ E $: Energy demand [MJ]
- $ f $: Fuel demand [kg]
-- $ mat $: Material demand [kg]
+- $ m_{mat} $: Material demand [kg]
The emissions of CO2, H2O, NOx, CO, SO2, CH4, HC and soot are determined. For the testing phase during development, perfluorinated hydrocarbons (PFC), non methane volatile organic compounds (NMVOC) and nitrous oxide emissions (N2O) are additionally calculated.
@@ -260,7 +266,7 @@ Resources for disassembly and dismantling are determined as for the final assemb
$energy [MJ] = specificEnergy[MJ/a] \cdot \frac{costs [\$]}{wage [\$/h] \cdot hoursPerYear [h/a]} \cdot t [yr]$
-The EoL scenario hardcoded in the module contains recycling, incineration and landfill rates for the aircraft components. The energy needed for all materials/components and all cases is summed up. With the ratios if incineration and landfill, the energy for all components and materials are calculated like this:
+The EoL scenario hardcoded in the module contains recycling, incineration and landfill rates for the aircraft components. The energy needed for all materials/components and all cases is summed up. With the ratios of incineration and landfill, the energy for all components and materials are calculated like this:
$ energy [MJ] = specificEnergy [MJ/kg] \cdot componentMass \cdot $
@@ -570,7 +576,9 @@ The forcing factors can be interpolated from given data and average values per m
In a next step, the radiative forcing is normalized with the species' efficacy f and $RF_{2xCO_2}$, the RF which would result from a doubling of CO2:
-$RF^{*}_{i}(t,h) = f_i \cdot \frac{RF_i(t,h)}{RF_{2xCO_2}} $
+$$
+ RF^{*}_{i}(t,h) = f_i \cdot \frac{RF_i(t,h)}{RF_{2xCO_2}}
+$$
With these values, a temperature change can be determined:
diff --git a/docs/documentation/analysis/ecological_assessment/index.md b/docs/documentation/analysis/ecological_assessment/index.md
index 776e1d9..6420e29 100644
--- a/docs/documentation/analysis/ecological_assessment/index.md
+++ b/docs/documentation/analysis/ecological_assessment/index.md
@@ -1,4 +1,5 @@
# Introduction {#mainpage}
+## Overview
The tool _ecological\_assessment_ is one of the last modules in the UNICADO toolchain, serving as an assessment module executed after the aircraft sizing loop. As its name suggests, it is made to evaluate the ecological performance of your aircraft design. By using this tool, you gain the opportunity to contribute to the development of environmentally friendly aircraft, playing a part in shaping a sustainable future for aviation. ✈️🌱🌎
The module enables you to assess various ecological factors, including aircraft emission masses and their broader environmental impacts. These impacts are analyzed, for example, in terms of their contributions to climate change and air quality, helping you understand the environmental footprint of your design in a comprehensive way.
@@ -31,10 +32,7 @@ If you are familiar with the above mentioned concepts and want to contribute - h
The following pages will help you to get into coding:
-- [Developer Guide](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/developer-installation/)
-- [Build Instructions](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/build/general/)
-- [Module Structure in c++](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/style/cpp-modularization/)
-- [UNICADO C++ Style Guide](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/style/cpp/)
+- [Developer Guide](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/get-involved/developer-installation/)
- [Tool Structure of ecological_assessment ](software-architecture.md)
!!!note
diff --git a/docs/documentation/analysis/ecological_assessment/software-architecture.md b/docs/documentation/analysis/ecological_assessment/software-architecture.md
index 3b6c296..03fcde2 100644
--- a/docs/documentation/analysis/ecological_assessment/software-architecture.md
+++ b/docs/documentation/analysis/ecological_assessment/software-architecture.md
@@ -2,15 +2,15 @@
If you're interested in developing this module, reading this chapter could be helpful. It provides some insights into the software (folder) structure and shall help you to find a way around :flashlight:
-As you have for sure carefully read our (developer guide)[https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/get-involved/developer-installation/], you already know everything about the modularized structure of the UNICADO and the top, intermediate and low level of its modules. So, here is how the *ecological_assessment* tool looks like:
+As you have for sure carefully read our [developer guide](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/get-involved/developer-installation/), you already know everything about the modularized structure of the UNICADO and the top, intermediate and low level of its modules. So, here is how the *ecological_assessment* tool looks like:
- On the top level, nothing fancy happens. Within the *src* directory, you will find the `main_ecological_assessment.cpp` which executes the module and the `ecolocical_assessment.cpp`/`ecolocical_assessment.h`, where the class EcologicalAssessment, which is inherited from the class Module, is defined. Therefor, it will run the functions `initialize`, `run`, `update`, `report` and `save` of the strategy. The save function will save and close the aircraft XML file and close the configuration file. In the class definition, you the RuntimeIO pointer is
- The intermediate level is structured by the implemented strategies. This section is a short one: there is only one strategy implemented in the module. It is called **STANDARD** and provides access to all the submodules.
-- On the low level, you'll find all in (basic concepts)[basic-concepts.md] described methods. The folder structure is like the module structure. So the *standard_strategy* is subdivided into *emission_calculation* and *impact_calulation*. In the directory, there is the class StandardStrategy, which contains the definition of `initialize`, `run`, `update`, `report` and `save`. The class can be seen as the coordinator of the submodules: in `initialize` it reads from the configuration file, which submodules shall be executed and prepares the `ecological_assessment_results.xml`. In `run`, the submodule's `run` functions are executed. In `update`, the aircraft exchange file will be updated and `report` calls the both the plotting and report functions of all executed submodules and generates the overall module reports. In a last step, `save` will save the `ecological_assessment_results.xml`. The *standard_strategy* directory additionally contains teh definition of emissionsClass, which provides a collection all emissions calculated by the module. Within the folder *emission_calculation* there are directories for *mission_emissions* and *life_cycle_emissions* which contain the corresponding methods. In addition, the class ecoDatabase offers access to database data used for calculations. The directory *impact_calculation* contains all methods to determine the impact of the emissions.
+- On the low level, you'll find all in [basic concepts](basic-concepts.md) described methods. The folder structure is like the module structure. So the *standard_strategy* is subdivided into *emission_calculation* and *impact_calulation*. In the directory, there is the class StandardStrategy, which contains the definition of `initialize`, `run`, `update`, `report` and `save`. The class can be seen as the coordinator of the submodules: in `initialize` it reads from the configuration file, which submodules shall be executed and prepares the `ecological_assessment_results.xml`. In `run`, the submodule's `run` functions are executed. In `update`, the aircraft exchange file will be updated and `report` calls the both the plotting and report functions of all executed submodules and generates the overall module reports. In a last step, `save` will save the `ecological_assessment_results.xml`. The *standard_strategy* directory additionally contains teh definition of emissionsClass, which provides a collection all emissions calculated by the module. Within the folder *emission_calculation* there are directories for *mission_emissions* and *life_cycle_emissions* which contain the corresponding methods. In addition, the class ecoDatabase offers access to database data used for calculations. The directory *impact_calculation* contains all methods to determine the impact of the emissions.
-All submodules have a class _IOData_, which contains all data from acXML and functions to read or write the data. Additionally, the class has a member _configuration_, which provides access to configuration file data. The `run` function of the submodules shall call functions to
+ All submodules have a class _IOData_, which contains all data from acXML and functions to read or write the data. Additionally, the class has a member _configuration_, which provides access to configuration file data. The `run` function of the submodules shall call functions to
- initialize the data,
- perform the calculation routines
--
GitLab