fastga_he.gui.lca_impact module
- fastga_he.gui.lca_impact.lca_impacts_sun_breakdown(aircraft_file_path: str | Path | List[str | Path], full_burst: bool = False, name_aircraft: str | List[str] | None = None, rel: str = 'absolute') FigureWidget[source]
Give a breakdown of the single score impact of the aircraft under the form of a sun breakdown.
- Parameters:
aircraft_file_path – path to the output file that contains the weighted and aggregated
impacts :param full_burst: boolean to display all levels of impacts :param name_aircraft: name of the aircraft :param rel: string to display impacts in a relative form. By default, it is not done. Can be relative to the “single_score” or relative to the “parent”.
- fastga_he.gui.lca_impact.lca_score_sensitivity_simple(results_folder_path: str | Path, prefix: str, name: str | None = None, impact_to_plot: str = 'single_score', fig: Figure | None = None) Figure[source]
Displays the evolution of the impacts of an aircraft with respect to its lifespan. This method is a bit sensitive to use as it requires the results to be stored under the form of FAST-OAD output files, all in the same folder and all with the same prefix. It also requires the user to know and input said prefix. Results can be superimposed to an existing figure, but it is recommended to only put results computed on the same lifespan.
- Parameters:
results_folder_path – path to the folder that contains the output files that contains
the results. :param prefix: prefix of the output file for the aircraft. :param impact_to_plot: Name of the impact to plot. :param name: name of the aircraft, to be displayed on the figure. :param fig: figure with existing results.
- Returns:
plotly figure with the evolution of the impact as a function of the lifespan.
- fastga_he.gui.lca_impact.lca_score_sensitivity_advanced_impact_category(results_folder_path: str | Path, prefix: str, cutoff_criteria: float, name: str | None = None) Figure[source]
Displays the evolution of the impacts of an aircraft in terms of single score with respect to its lifespan by stacking the contributing impact category. This method is a bit sensitive to use as it requires the results to be stored under the form of FAST-OAD output files, all in the same folder and all with the same prefix. It also requires the user to know and input said prefix. In order not to overload the diagram, we’ll allow the user to set a cutoff criteria below which not to plot the contribution of the impact. The rest will be aggregated into others.
- Parameters:
results_folder_path – path to the folder that contains the output files that contains
the results. :param prefix: prefix of the output file for the aircraft. :param name: name of the aircraft, to be displayed on the figure. :param cutoff_criteria: cutoff criteria, in % of the single score on the last year (e.g. enter 5 for 5% percent not 0.05)
- Returns:
plotly figure with the evolution of all the impact contributing ot the single score
as a function of the lifespan.
- fastga_he.gui.lca_impact.lca_score_sensitivity_advanced_components(results_folder_path: str | Path, prefix: str, cutoff_criteria: float, name: str | None = None) Figure[source]
Displays the evolution of the contribution to the single score of each component of the aircraft as a function of the estimated lifespan of the aircraft. This method is a bit sensitive to use as it requires the results to be stored under the form of FAST-OAD output files, all in the same folder and all with the same prefix. It also requires the user to know and input said prefix. In order not to overload the diagram, we’ll allow the user to set a cutoff criteria. The rest will be aggregated into others.
- Parameters:
results_folder_path – path to the folder that contains the output files that contains
the results. :param prefix: prefix of the output file for the aircraft. :param name: name of the aircraft, to be displayed on the figure. :param cutoff_criteria: cutoff criteria, in % of the single score on the last year (e.g. enter 5 for 5% percent not 0.05)
- Returns:
plotly figure with the evolution of all the components contributing ot the single score
as a function of the lifespan.
- fastga_he.gui.lca_impact.lca_score_sensitivity_advanced_components_and_phase(results_folder_path: str | Path, prefix: str, cutoff_criteria: float, name: str | None = None, force_order: list | None = None) Figure[source]
Displays the evolution of the contribution to the single score of each component of the aircraft as a function of the estimated lifespan of the aircraft and separates them by phase. This method is a bit sensitive to use as it requires the results to be stored under the form of FAST-OAD output files, all in the same folder and all with the same prefix. It also requires the user to know and input said prefix. In order not to overload the diagram, we’ll allow the user to set a cutoff criteria. The rest will be aggregated into others. For components whose total contribution is greater than the cutoff we’ll highlight if their biggest impact comes from the production phase or the use phase
- Parameters:
results_folder_path – path to the folder that contains the output files that contains
the results. :param prefix: prefix of the output file for the aircraft. :param name: name of the aircraft, to be displayed on the figure. :param cutoff_criteria: cutoff criteria, in % of the single score on the last year (e.g. enter 5 for 5% percent not 0.05) :param force_order: for values that aren’t cutoff, forces an order of display from bottom to top.
- Returns:
plotly figure with the evolution of all the components contributing ot the single score
as a function of the lifespan.
- fastga_he.gui.lca_impact.lca_impacts_bar_chart_simple(aircraft_file_paths: str | Path | List[str | Path], names_aircraft: str | List[str] | None = None, impact_step: str = 'weighted', graph_title: str | None = None, impact_filter_list: list | None = None) FigureWidget[source]
Give a bar chart that compares multiples aircraft designs across all categories. This comparison is done relative to the first design given in the inputs. Can be used with only one design but is pointless since it will compare an aircraft to itself.
- Parameters:
aircraft_file_paths – paths to the output file that contains the impacts.
names_aircraft – names of the aircraft.
impact_step – step of the LCIA to consider, by default weighted impacts are considered,
can also be “normalized” or “raw” results. :param graph_title: title of the graph, if None are specified one is created based on the aircraft names :param impact_filter_list: filter to only show impact in the list in output graph. By default everything is plotted.
- fastga_he.gui.lca_impact.lca_impacts_bar_chart_normalised(aircraft_file_paths: str | Path | List[str | Path], names_aircraft: str | List[str] | None = None) FigureWidget[source]
Give a bar chart that compares multiples aircraft designs across all categories. This comparison is done in terms of normalized results. Can be used with only one design.
- Parameters:
aircraft_file_paths – paths to the output file that contains the impacts.
names_aircraft – names of the aircraft.
- fastga_he.gui.lca_impact.lca_raw_impact_comparison(aircraft_file_paths: str | Path | List[str | Path], names_aircraft: str | List[str] | None = None, impact_category: str | None = None) FigureWidget[source]
Plots, on bar chart, the simple comparison in one impact category of one or more designs.
- Parameters:
aircraft_file_paths – paths to the output file that contains the impacts.
names_aircraft – names of the aircraft.
impact_category – impact category to plot, by default the first one alphabetically will
be plotted
- fastga_he.gui.lca_impact.lca_raw_impact_comparison_advanced(aircraft_file_paths: str | Path | List[str | Path], names_aircraft: str | List[str] | None = None, impact_category: str | None = None, aggregate_and_sort_contributor: Dict[str, str | List[str]] | None = None) FigureWidget[source]
Plots, on bar chart, the comparison in one impact category of one or more designs with a detail of each contributor
- Parameters:
aircraft_file_paths – paths to the output file that contains the impacts.
names_aircraft – names of the aircraft.
impact_category – impact category to plot, by default the first one alphabetically will
be plotted :param aggregate_and_sort_contributor: dict of contributor to aggregate and name under which to aggregate them. Keys are new names and items are a list of old names. The order in which new names are given will also serve as the order in which we plot contributors starting from the bottom.
- fastga_he.gui.lca_impact.lca_impacts_bar_chart_normalised_weighted(aircraft_file_paths: str | Path | List[str | Path], names_aircraft: str | List[str] | None = None, impact_filter_list: list | None = None) FigureWidget[source]
Give a bar chart that compares multiples aircraft designs across all categories. This comparison is done relative to the first design given in the inputs. Can be used with only one design but is pointless since it will compare an aircraft to itself.
- Parameters:
aircraft_file_paths – paths to the output file that contains the impacts.
names_aircraft – names of the aircraft.
impact_filter_list – filter to only show impact in the list in output graph. By default
everything is plotted.
- fastga_he.gui.lca_impact.lca_impacts_bar_chart_with_contributors(aircraft_file_path: str | Path, name_aircraft: str | None = None, detailed_component_contributions: bool = False, legend_rename: dict | None = None, aggregate_phase: list | None = None, impact_filter_list: list | None = None, impact_step: str = 'weighted', aggregate_and_sort_contributor: Dict[str, str | List[str]] | None = None) FigureWidget[source]
Give a bar chart that plot the impact of an aircraft in each category and how each component contributes to it in relative terms.
- Parameters:
aircraft_file_path – path to the output file that contains the results of the LCA
name_aircraft – name of the aircraft.
detailed_component_contributions – by default, the contribution in each phase of a
components are summed together and only the total is shown, this allows to see the contribution in each phase of each component :param legend_rename: legend names are set by the code by default, if any renaming is to be done, pass here the legend to be renamed as key and how to rename it as item. :param aggregate_phase: for compactness, it may be preferable to aggregate the contribution of all components to a phase. This options is a list of phases to aggregate. Please note that the aggregation of the manufacturing and distribution can’t be changed (see the documentation). :param impact_filter_list: filter to only show impact in the list in output graph :param impact_step: step of the LCIA to consider, by default weighted impacts are considered, can also be “normalized” results. :param aggregate_and_sort_contributor: dict of contributor to aggregate and name under which to aggregate them. Keys are new names and items are a list of old names. The order in which new names are given will also serve as the order in which we plot contributors starting from the bottom.
- fastga_he.gui.lca_impact.lca_impacts_bar_chart_with_components_absolute(aircraft_file_path: str | Path, name_aircraft: str | None = None, detailed_component_contributions: bool = False, legend_rename: dict | None = None, aggregate_phase: list | None = None, cutoff_criteria: float | None = None) FigureWidget[source]
Provide a bar chart of the weighted impacts of an aircraft, showing the absolute value of each component’s contribution across all impact categories.
- Parameters:
aircraft_file_path – path to the output file that contains the results of the LCA
name_aircraft – name of the aircraft
detailed_component_contributions – by default, all contribution of one component,
regardless of the phase is aggregated, this segregates them. :param legend_rename: legend names are set by the code by default, if any renaming is to be done, pass here the legend to be renamed as key and how to rename it as item. :param aggregate_phase: by default only the manufacturing and distribution are aggregated. Additional phase specified here can be aggregated. :param cutoff_criteria: value of the cutoff criteria, in percent of the single score.
- fastga_he.gui.lca_impact.lca_impacts_search_table(aircraft_file_path: str | Path, impact_criteria: List[str], phase_criteria: List[str], component_criteria: List[str], rel: bool = False) list[source]
Can be used as a very simple search engine of impacts and their contribution to the single score. Can give criteria on what impacts/phases/components to consider. If an asterisk is used the sum of all variable name that matches will be used. Can also be returned as a percent of the total score rather than an absolute value.
- Parameters:
aircraft_file_path – path to the output file that contains the results of the LCA
impact_criteria – criterion on impacts to consider
phase_criteria – criterion on phases to consider
component_criteria – criterion on components to consider
rel – boolean to return the variable as a percentage