Skip to content
Snippets Groups Projects
Commit 9b05ee0d authored by Andi's avatar Andi
Browse files

Merge branch 'documentation/update_cost_estimation' into 'develop'

Documentation/update cost estimation

See merge request !39
parents 5dd4ae6d e2440ec2
No related branches found
No related tags found
3 merge requests!76Draft: Updated Python code example,!73Initial open source version,!39Documentation/update cost estimation
Pipeline #1607981 passed
# Getting started
This section will guide you through the necessary steps to get the _cost\_estimation_ module up and running. It contains information on tool requirements and design parameters.
- [Aircraft exchange file](#aircraft-exchange-file) - Get information on necessary parameters from the _acXML_.
- [Module configuration file](#module-configuration-file) - Dive into cost estimation specific parameters.
- [Additional requirements](#additional-requirements) - Is anything else necessary to get the module running?
......@@ -9,6 +10,7 @@ This section will guide you through the necessary steps to get the _cost\_estima
It is assumed that you have the `UNICADO package` installed including the executables and UNICADO libraries.
Generally, we use two files to set or configure modules in UNICADO:
- The aircraft exchange file (or _acXML_) includes
- data related inputs (e.g., aircraft configuration, transport task) and
- data related outputs (e.g., annual direct operating costs).
......@@ -22,6 +24,7 @@ In the following sections you will find more information on how to configure the
Since the _cost\_estimation_ module is an assessment tool, it is assumed that a converged aircraft design and therefore all the necessary data are already available.
The following information is needed from the _acXML_:
1. Design specification
- Configuration information: Configuration type
- Transport task: Passenger definition, passenger class definition, and cargo definition
......@@ -71,16 +74,13 @@ Program Settings
| | | | | | - Price per operating empty mass
| | | | | | - Rate insurance
| | | | | | - Rate interest
| | | | | | - Residual value factor
| | | | | - Crew
| | | | | | - Salary variation
| | | | | - Flight cycles
| | | | | | - Block time per flight
| | | | | | - Block time supplement per flight
| | | | | | - Daily night curfew time
| | | | | | - Potential annual operation time
| | | | | | - Annual lay days overhaul
| | | | | | - Annual lay days reserve
| | | | | | - Annual lay days maintenance
| | | | | | - Annual lay hours overhaul
| | | | | | - Annual lay hours reserve
| | | | | | - Annual lay hours maintenance
| | | | | - Handling
| | | | | | - Fees handling
| | | | | - Landing
......
# Introduction {#mainpage}
Welcome to the _cost\_estimation_ module in UNICADO – where we take your aircraft operating costs from “hmm… probably a lot?” to laser-accurate precision! This tool is like a financial :crystal_ball for your aircraft, crunching numbers on fuel, maintenance, crew costs, and just about (almost) every other expense you can imagine. Think of it as your budgeting co-pilot, always ready to calculate so you can focus on the skies instead of spreadsheets. With _cost\_estimation_, you stay in control, keep the accountants happy, and land at your bottom line without any turbulence. So buckle up, and let’s start calculating!
Welcome to the _cost\_estimation_ module in UNICADO – where we take your aircraft operating costs from “hmm… probably a lot?” to laser-accurate precision! This tool is like a financial :crystal_ball: for your aircraft, crunching numbers on fuel, maintenance, crew costs, and just about (almost) every other expense you can imagine. Think of it as your budgeting co-pilot, always ready to calculate so you can focus on the skies instead of spreadsheets. With _cost\_estimation_, you stay in control, keep the accountants happy, and land at your bottom line without any turbulence. So buckle up, and let’s start calculating!
## Summary of features
Here’s a quick rundown of what the tool currently does, along with a sneak peek at what's planned:
......@@ -15,10 +15,12 @@ Blended-wing-body |... |... |under development
## A user's guide to cost calculation
The _cost\_estimation_ tool is your key to accurately calculating the operating costs of an aircraft. In this user documentation, you’ll find all the information you need to understand the tool, as well as the necessary inputs and configurations to run a cost analysis from the ground up.
The following sections will walk you through the cost estimation process in UNICADO:
- [Getting started](getting_started.md)
- [Run your first cost estimation](run_your_first_cost_estimation.md)
For a comprehensive understanding of the tool’s functionality, the documentation is structured into two distinct sections:
- A [method description](operating_cost_method.md) and
- a [software architecture](software_architecture.md)
section.
......
......@@ -3,13 +3,14 @@ Let's dive into the fun part and crunch some numbers! :moneybag:
## Tool single execution
The tool can be executed from the console directly if all paths are set. The following will happen:
- [Console output](#console-output)
- [Generation of reports and plots](#reporting)
- [Writing output to aircraft exchange file](#write-data-to-acxml)
Some of the above mentioned steps did not work? Check out the [troubleshooting](#troubleshooting) section for advices. Also, if you need some additional information on the underlying methodology, check out the page on the [cost estimation method](operating_cost_method.md).
So, feel free to open the terminal and run `cost_estimation.exe` to see what happens...
So, feel free to open the terminal and run `python.exe cost_estimation.py` to see what happens...
### Console output {#console-output}
Firstly, you see output in the console window. Let's go through it step by step...
......@@ -45,7 +46,7 @@ The tool continues to check if an off-design study exists and tries to calculate
```
2024-12-06 11:37:30,641 - PRINT - Plots are generated and saved...
2024-12-06 11:37:38,187 - WARNING - Warning: "html_output" switch in module configuration file set to "False". No HTML report generated.
2024-12-06 11:37:38,187 - PRINT - HTML report is generated and saved...
2024-12-06 11:37:38,188 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
2024-12-06 11:37:38,192 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
2024-12-06 11:37:38,192 - PRINT - Cost estimation finished.
......@@ -54,9 +55,10 @@ Finally, you receive information about the reports and plots created (depending
### Reporting {#reporting}
In the following, a short overview is given on the generated reports:
- A `cost_estimation.log` file is written within the directory of the executable
- Depending on your settings, the following output is generated and saved in the `reporting` folder, located in the directory of the aircraft exchange file:
- an HTML report in the `report_html` folder (not implemented yet)
- an HTML report in the `report_html` folder
- a TeX report in the `report_tex` folder (not implemented yet)
- an XML file with additional output data in the `report_xml` folder
- plots in the `plots` folder
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment