Skip to main content
Ctrl+K

Pyglotaran-Extras

  • Installation
  • Usage
  • Configuration
  • Going beyond builtin
  • Inner workings
    • Contributing
    • Changelog
  • GitHub
  • Installation
  • Usage
  • Configuration
  • Going beyond builtin
  • Inner workings
  • Contributing
  • Changelog
  • GitHub

Section Navigation

  • pyglotaran_extras
    • config
      • config
        • create_config_schema
        • discover_config_files
        • find_config_in_dir
        • load_config
        • load_config_files
        • merge_configs
        • Config
        • UsePlotConfigError
      • plot_config
        • create_parameter_docstring_mapping
        • extract_default_kwargs
        • find_axes
        • find_not_user_provided_kwargs
        • plot_config_context
        • use_plot_config
        • DefaultKwarg
        • PerFunctionPlotConfig
        • PlotConfig
        • PlotLabelOverrideMap
        • PlotLabelOverrideValue
      • utils
        • add_yaml_repr
        • to_yaml_str
    • deprecation
      • deprecation_utils
        • check_overdue
        • parse_version
        • pyglotaran_extras_version
        • warn_deprecated
        • OverdueDeprecationError
        • PyglotaranExtrasApiDeprecationWarning
    • inspect
      • a_matrix
        • a_matrix_to_html_table
        • show_a_matrixes
      • cycler
        • create_preview_cycler
        • inspect_cycler
      • utils
        • pretty_format_numerical
        • pretty_format_numerical_iterable
        • wrap_in_details_tag
    • io
      • load_data
      • setup_case_study
      • utils
        • result_dataset_mapping
    • plotting
      • plot_coherent_artifact
        • plot_coherent_artifact
      • plot_concentrations
        • plot_concentrations
      • plot_data
        • plot_data_overview
      • plot_doas
        • plot_doas
      • plot_guidance
        • plot_guidance
      • plot_irf_dispersion_center
        • plot_irf_dispersion_center
      • plot_overview
      • plot_pfid
        • plot_pfid
      • plot_residual
        • plot_residual
      • plot_spectra
        • plot_das
        • plot_norm_das
        • plot_norm_sas
        • plot_sas
        • plot_spectra
      • plot_svd
        • ensure_residual_svd
        • plot_lsv_data
        • plot_lsv_residual
        • plot_rsv_data
        • plot_rsv_residual
        • plot_sv_data
        • plot_sv_residual
        • plot_svd
      • plot_traces
        • plot_data_and_fits
        • plot_fitted_traces
      • style
        • ColorCode
        • DataColorCode
        • DataLineStyle
        • LineStyle
        • PlotStyle
      • utils
        • abs_max
        • add_cycler_if_not_none
        • add_subplot_labels
        • add_unique_figure_legend
        • calculate_ticks_in_units_of_pi
        • condense_numbered_strings
        • ensure_axes_array
        • extract_dataset_scale
        • extract_irf_dispersion_center
        • extract_irf_location
        • format_sub_plot_number_upper_case_letter
        • get_next_cycler_color
        • get_shifted_traces
        • get_subplot_label_format_function
        • maximum_coordinate_range
        • not_single_element_dims
        • select_irf_dispersion_center_by_index
        • select_plot_wavelengths
        • shift_time_axis_by_irf_location
        • MinorSymLogLocator
        • PlotDuplicationWarning
    • types
      • pyglotaran_extras.types.Unset
      • pyglotaran_extras.types.DatasetConvertible
      • pyglotaran_extras.types.ResultLike
      • pyglotaran_extras.types.BuiltinSubPlotLabelFormatFunctionKey
      • CyclerColor
        • clear
        • copy
        • fromkeys
        • get
        • items
        • keys
        • pop
        • popitem
        • setdefault
        • update
        • values
      • UnsetType
    • pyglotaran_extras.SCRIPT_DIR
    • pyglotaran_extras.CONFIG
  • Inner workings
  • pyglotaran_extras
  • inspect
  • utils

utils#

Inspection utility module.

Functions#

Summary

pretty_format_numerical

Format value with with at most decimal_places decimal places.

pretty_format_numerical_iterable

Pretty format numerical values in an iterable of numerical values or strings.

wrap_in_details_tag

Wrap details_content in a html details tag and add summary if summary_content set.

previous

inspect_cycler

next

pretty_format_numerical

On this page
  • Functions

This Page

  • Show Source

© Copyright 2021, Joris Snellenburg.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.16.1.