Skip to content

Latest commit

 

History

History
209 lines (164 loc) · 3.28 KB

api.rst

File metadata and controls

209 lines (164 loc) · 3.28 KB

SourceSpec API

SourceSpec has a modular structure. Each module corresponds to a specific function or class of functions.

Main modules

SourceSpec main modules are presented below, following the logical order on which they're used within source_spec.py.

source_spec.py

.. automodule:: source_spec
   :members:


ssp_parse_arguments

.. automodule:: ssp_parse_arguments
   :members:

ssp_setup

.. automodule:: ssp_setup
   :members:

ssp_read_traces

.. automodule:: ssp_read_traces
   :members:

ssp_process_traces

.. automodule:: ssp_process_traces
   :members:

ssp_build_spectra

.. automodule:: ssp_build_spectra
   :members:

ssp_plot_traces

.. automodule:: ssp_plot_traces
   :members:

ssp_inversion

.. automodule:: ssp_inversion
   :members:

ssp_radiated_energy

.. automodule:: ssp_radiated_energy
   :members:

ssp_local_magnitude

.. automodule:: ssp_local_magnitude
   :members:

ssp_summary_statistics

.. automodule:: ssp_summary_statistics
   :members:

ssp_output

.. automodule:: ssp_output
   :members:

ssp_residuals

.. automodule:: ssp_residuals
   :members:

ssp_plot_spectra

.. automodule:: ssp_plot_spectra
   :members:

ssp_plot_stacked_spectra

.. automodule:: ssp_plot_stacked_spectra
   :members:

ssp_plot_params_stats

.. automodule:: ssp_plot_params_stats
   :members:

ssp_plot_stations

.. automodule:: ssp_plot_stations
   :members:

ssp_html_report

.. automodule:: ssp_html_report
   :members:


Other modules

These modules, in alphabetical order, are used by the main modules.

ssp_correction

.. automodule:: ssp_correction
   :members:

ssp_data_types

.. automodule:: ssp_data_types
   :members:

ssp_event

.. automodule:: ssp_event
   :members:

ssp_grid_sampling

.. automodule:: ssp_grid_sampling
   :members:

ssp_pick

.. automodule:: ssp_pick
   :members:

ssp_spectral_model

.. automodule:: ssp_spectral_model
   :members:

ssp_qml_output

.. automodule:: ssp_qml_output
   :members:

ssp_radiation_pattern

.. automodule:: ssp_radiation_pattern
   :members:

ssp_read_sac_header

.. automodule:: ssp_read_sac_header
   :members:

ssp_read_station_metadata

.. automodule:: ssp_read_station_metadata
   :members:

ssp_sqlite_output

.. automodule:: ssp_sqlite_output
   :members:

ssp_update_db

.. automodule:: ssp_update_db
   :members:

ssp_util

.. automodule:: ssp_util
   :members:

ssp_wave_arrival

.. automodule:: ssp_wave_arrival
   :members:

config

.. automodule:: config
   :members:

kdtree

.. automodule:: kdtree
   :members:

savefig

.. automodule:: savefig
   :members:

spectrum

.. automodule:: spectrum
   :members:

clipping_detection

.. automodule:: clipping_detection
   :members:

plot_sourcepars

.. automodule:: plot_sourcepars
   :members: