Automated sphinx build

chime-experiment · Jul 21, 2024 · 0f27baf · 0f27baf
1 parent 487532e
commit 0f27baf
Show file tree

Hide file tree

Showing 137 changed files with 51,554 additions and 0 deletions.
diff --git a/doc/_autosummary/ch_util._db_tables.rst b/doc/_autosummary/ch_util._db_tables.rst
@@ -0,0 +1,70 @@
+ch\_util.\_db\_tables
+=====================
+
+.. automodule:: ch_util._db_tables
+
+
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+
+      EVENT_AT
+      EVENT_BEFORE
+      EVENT_AFTER
+      EVENT_ALL
+      ORDER_ASC
+      ORDER_DESC
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      add_component
+      compare_connexion
+      connect_peewee_tables
+      make_connexion
+      remove_component
+      set_property
+      set_user
+      sever_connexion
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      component
+      component_doc
+      component_history
+      component_type
+      component_type_rev
+      connexion
+      event
+      event_table
+      event_type
+      external_repo
+      global_flag
+      global_flag_category
+      graph_obj
+      predef_subgraph_spec
+      predef_subgraph_spec_param
+      property
+      property_component
+      property_type
+      timestamp
+      user_permission
+      user_permission_type
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+
+      BadSubgraph
+      ClosestDraw
+      DoesNotExist
+      LayoutIntegrity
+      NoPermission
+      NoSubgraph
+      PropertyType
+      PropertyUnchanged
+      UnknownUser
+
diff --git a/doc/_autosummary/ch_util.andata.rst b/doc/_autosummary/ch_util.andata.rst
@@ -0,0 +1,48 @@
+ch\_util.andata
+===============
+
+.. automodule:: ch_util.andata
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      andata_from_acq1
+      andata_from_archive2
+      subclass_from_obj
+      versiontuple
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      AnData
+      BaseData
+      BaseReader
+      CalibrationGainData
+      CalibrationGainReader
+      CorrData
+      CorrReader
+      DigitalGainData
+      DigitalGainReader
+      FlagInputData
+      FlagInputReader
+      GainData
+      GainFlagData
+      HKData
+      HKPData
+      HKPReader
+      HKReader
+      RawADCData
+      RawADCReader
+      Reader
+      WeatherData
+      WeatherReader
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+
+      AnDataError
+
diff --git a/doc/_autosummary/ch_util.cal_utils.rst b/doc/_autosummary/ch_util.cal_utils.rst
@@ -0,0 +1,37 @@
+ch\_util.cal\_utils
+===================
+
+.. automodule:: ch_util.cal_utils
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      estimate_directional_scale
+      fit_histogram
+      fit_point_source_map
+      flag_outliers
+      func_2d_gauss
+      func_2d_sinc_gauss
+      func_dirty_gauss
+      func_real_dirty_gauss
+      get_reference_times_dataset_id
+      get_reference_times_file
+      guess_fwhm
+      interpolate_gain
+      interpolate_gain_quiet
+      thermal_amplitude
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      FitAmpPhase
+      FitGaussAmpPolyPhase
+      FitPoly
+      FitPolyLogAmpPolyPhase
+      FitPolyRealPolyImag
+      FitRealImag
+      FitTransit
+
diff --git a/doc/_autosummary/ch_util.chan_monitor.rst b/doc/_autosummary/ch_util.chan_monitor.rst
@@ -0,0 +1,13 @@
+ch\_util.chan\_monitor
+======================
+
+.. automodule:: ch_util.chan_monitor
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      ChanMonitor
+      FeedLocator
+
diff --git a/doc/_autosummary/ch_util.connectdb.rst b/doc/_autosummary/ch_util.connectdb.rst
@@ -0,0 +1,6 @@
+ch\_util.connectdb
+==================
+
+.. automodule:: ch_util.connectdb
+
+
diff --git a/doc/_autosummary/ch_util.data_index.rst b/doc/_autosummary/ch_util.data_index.rst
@@ -0,0 +1,6 @@
+ch\_util.data\_index
+====================
+
+.. automodule:: ch_util.data_index
+
+
diff --git a/doc/_autosummary/ch_util.data_quality.rst b/doc/_autosummary/ch_util.data_quality.rst
@@ -0,0 +1,12 @@
+ch\_util.data\_quality
+======================
+
+.. automodule:: ch_util.data_quality
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      good_channels
+
diff --git a/doc/_autosummary/ch_util.ephemeris.rst b/doc/_autosummary/ch_util.ephemeris.rst
@@ -0,0 +1,41 @@
+ch\_util.ephemeris
+==================
+
+.. automodule:: ch_util.ephemeris
+
+
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+
+      CasA
+      CygA
+      TauA
+      VirA
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      Star_cirs
+      bmxy_to_hadec
+      chime_local_datetime
+      cirs_radec
+      galt_pointing_model_dec
+      galt_pointing_model_ha
+      get_doppler_shifted_freq
+      get_range_rate
+      get_source_dictionary
+      hadec_to_bmxy
+      lunar_rising
+      lunar_setting
+      lunar_transit
+      object_coords
+      parse_date
+      peak_RA
+      solar_rising
+      solar_setting
+      solar_transit
+      transit_RA
+      utc_lst_to_mjd
+
diff --git a/doc/_autosummary/ch_util.finder.rst b/doc/_autosummary/ch_util.finder.rst
@@ -0,0 +1,33 @@
+ch\_util.finder
+===============
+
+.. automodule:: ch_util.finder
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      files_in_range
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      BaseDataInterval
+      CalibrationGainDataInterval
+      CorrDataInterval
+      DataInterval
+      DataIntervalList
+      DigitalGainDataInterval
+      Finder
+      FlagInputDataInterval
+      HKDataInterval
+      WeatherDataInterval
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+
+      DataFlagged
+
diff --git a/doc/_autosummary/ch_util.fluxcat.rst b/doc/_autosummary/ch_util.fluxcat.rst
@@ -0,0 +1,25 @@
+ch\_util.fluxcat
+================
+
+.. automodule:: ch_util.fluxcat
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      format_source_name
+      get_epoch
+      json_numpy_obj_hook
+      varname
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      CurvedPowerLaw
+      FitSpectrum
+      FluxCatalog
+      MetaFluxCatalog
+      NumpyEncoder
+
diff --git a/doc/_autosummary/ch_util.holography.rst b/doc/_autosummary/ch_util.holography.rst
@@ -0,0 +1,13 @@
+ch\_util.holography
+===================
+
+.. automodule:: ch_util.holography
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      HolographyObservation
+      HolographySource
+
diff --git a/doc/_autosummary/ch_util.layout.rst b/doc/_autosummary/ch_util.layout.rst
@@ -0,0 +1,21 @@
+ch\_util.layout
+===============
+
+.. automodule:: ch_util.layout
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      enter_ltf
+      get_global_flag_times
+      global_flags_between
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      graph
+      subgraph_spec
+
diff --git a/doc/_autosummary/ch_util.ni_utils.rst b/doc/_autosummary/ch_util.ni_utils.rst
@@ -0,0 +1,30 @@
+ch\_util.ni\_utils
+==================
+
+.. automodule:: ch_util.ni_utils
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      gains2utvec
+      gains2utvec_tf
+      gen_prod_sel
+      ktrprod
+      mat2utvec
+      ni_als
+      ni_gains_evalues
+      ni_gains_evalues_tf
+      process_gated_data
+      process_synced_data
+      sort_evalues_mag
+      subtract_sky_noise
+      utvec2mat
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      ni_data
+
diff --git a/doc/_autosummary/ch_util.plot.rst b/doc/_autosummary/ch_util.plot.rst
@@ -0,0 +1,14 @@
+ch\_util.plot
+=============
+
+.. automodule:: ch_util.plot
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      spectra
+      time_ordered
+      waterfall
+