Functions documentation#
-Example 1: documentation of a specific function from the file ‘simunet_analysis.py’”#
-Using ‘autofunction’, we can document a specific function:
--
-
- -validphys.simunet_analysis.plot_nd_bsm_facs(read_bsm_facs, bsm_names_to_latex, posterior_plots_settings=None)# -
Plot a histogram for each BSM coefficient. -The nd is used for n-dimensional, if two BSM facs are present: use instead
-validphys.results.plot_2d_bsm_facs()-
-
- read_bsm_facspd.DataFrame
DataFrame containing the BSM factors.
-
-- bsm_names_to_latexdict
Dictionary mapping BSM names to LaTeX representations.
-
-- posterior_plots_settingsdict, optional
Settings for posterior plots, such as number of bins and range settings.
-
-
-
-
- figmatplotlib.figure.Figure
A matplotlib figure object for the histogram.
-
-
Example 2:#
-Using ‘automodule’, we can document all functions from simunet_analysis at once:
-Plots and analysis tools for SIMUnet.
+Functions documentation#
+Plots and analysis tools for SIMUnet.
- validphys.simunet_analysis.bsm_facs_68bounds_fits(fits, bsm_names_to_latex)# @@ -779,8 +742,8 @@
- -validphys.simunet_analysis.plot_nd_bsm_facs(read_bsm_facs, bsm_names_to_latex, posterior_plots_settings=None)# +
- +validphys.simunet_analysis.plot_nd_bsm_facs(read_bsm_facs, bsm_names_to_latex, posterior_plots_settings=None)#
Plot a histogram for each BSM coefficient. The nd is used for n-dimensional, if two BSM facs are present: use instead
validphys.results.plot_2d_bsm_facs()-
@@ -971,7 +934,6 @@
Example 2: -