analysis

Classes

analysis.@AllFigCompare.AllFigCompare

analysis.@DesignVars.DesignVars

analysis.@Parameters.Parameters

analysis.@ReadNonMatlabFigs.ReadNonMatlabFigs

analysis.@Validation.Validation

analysis.analysis_to_calkit

then run update_calkit.py to merge into calkit.yaml

class analysis.GenericAnalysis

GENERICANALYSIS Abstract class for MDOcean analyses Handles saving and loading of intermediate results, figures, and tables.

Constructor Summary
GenericAnalysis(p, b)
Property Summary
analysis_dependencies
analysis_outputs
b
class_dependencies
end_result_struct

only summary end results for latex output or tests

extra_analysis_inputs

non-code data inputs for calkit analysis stage

extra_analysis_outputs

non-code extra outputs beyond intermed.mat for calkit analysis stage

extra_postpro_inputs

non-code data inputs for calkit postpro stage

extra_postpro_outputs

non-code extra outputs for calkit postpro stage

fig_array
fig_names
intermed_result_struct

all results needed to debug and make plots

output_folder
p
postpro_dependencies
postpro_outputs
tab_array_display
tab_array_latex
tab_colspecs
tab_firstrows
tab_names
Method Summary
format_inputs_list(~, extras, deps)

FORMAT_INPUTS_LIST Format inputs as YAML list: extras first, then deps, de-duplicated.

format_outputs(~, outputs)

FORMAT_OUTPUTS Format a cell array of output paths as YAML list entries. .tex and .json outputs include ‘storage: git’; others are plain paths.

static get_dependencies(fcn_name)
load_intermed_results()
static make_rel_path(abs_paths, base)
run_all_from_analysis()
run_all_from_load()
run_all_from_load_if_possible()
run_analysis()
run_analysis_from_load_if_possible()
run_post_process()
save_end_results()
save_figs()
save_intermed_results()
save_tabs()
validate_figs(figs_in)

VALIDATE_FIGS Return only valid MATLAB figure handles from input Accepts graphics handles, cell arrays of handles, or empty.

write_calkit_stage()
analysis.get_all_analyses()

Function get_all_analyses()

returns:

analysis_list

GET_ALL_ANALYSES Returns cell array of strings of all analysis classes