API reference

Looking to call the calculator from a script? Start with Using the web API for the HTTP endpoints and interactive OpenAPI documentation. The references below describe the Python server and JavaScript client code.

Contents:

• Python server
  • Web API
    • create_app()
  • Models
    • FileConfigModel
      • FileConfigModel.model_config
    • EmissionConfigModel
      • EmissionConfigModel.model_config
    • TransmissionConfigModel
      • TransmissionConfigModel.model_config
    • SiteConfigModel
      • SiteConfigModel.model_config
    • TelescopeConfigModel
      • TelescopeConfigModel.model_config
    • DetectorConfigModel
      • DetectorConfigModel.path
      • DetectorConfigModel.gain
      • DetectorConfigModel.ron
      • DetectorConfigModel.scale
      • DetectorConfigModel.full_well
      • DetectorConfigModel.range
      • DetectorConfigModel.bias
      • DetectorConfigModel.transmission
      • DetectorConfigModel.emission
      • DetectorConfigModel.model_config
    • OpticsConfigModel
      • OpticsConfigModel.model_config
    • FiltersConfigModel
      • FiltersConfigModel.model_config
    • InstrumentConfigModel
      • InstrumentConfigModel.model_config
    • DataConfigModel
      • DataConfigModel.model_config
    • ETCValidationError
    • spectral_to_arrays()
    • CacheModel
      • CacheModel.model_config
    • DetectorModel
      • DetectorModel.gain
      • DetectorModel.ron
      • DetectorModel.scale
      • DetectorModel.full_well
      • DetectorModel.range
      • DetectorModel.bias
      • DetectorModel.transmissions
      • DetectorModel.emissions
      • DetectorModel.model_config
    • InstrumentModel
      • InstrumentModel.model_config
    • OpticsModel
      • OpticsModel.model_config
    • FiltersModel
      • FiltersModel.model_config
    • SBSEDModel
      • SBSEDModel.model_config
    • SEDModel
      • SEDModel.model_config
    • SiteModel
      • SiteModel.model_config
    • TelescopeModel
      • TelescopeModel.model_config
    • TransmissionModel
      • TransmissionModel.model_config
    • ETCQueryModel
      • ETCQueryModel.validate_filter()
      • ETCQueryModel.validate_mirror()
      • ETCQueryModel.model_config
    • ETCResponseModel
      • ETCResponseModel.model_config
    • FilterID
    • InstrumentID
    • MirrorID
  • Types
    • QuantityAnnotation
      • QuantityAnnotation.validate()
      • QuantityAnnotation.serialize()
    • AnnotatedQuantity()
    • str_to_quantity_array()
    • StrAnnotation
      • StrAnnotation.validate()
      • StrAnnotation.serialize()
    • AnnotatedStr()
  • Configuration
    • override()
    • SField()
  • Settings
    • HostSettings
      • HostSettings.model_config
    • ServerSettings
      • ServerSettings.model_config
    • EngineSettings
      • EngineSettings.model_config
    • MiscSettings
      • MiscSettings.model_config
    • AppSettings
      • AppSettings.host
      • AppSettings.server
      • AppSettings.engine
      • AppSettings.misc
      • AppSettings.model_config
• Python API client
  • Client
    • Client.api_url
    • Client.query()
• JavaScript client
  • Application URLs
    • url.root_url
    • url.etc_url
    • url.ui_url
    • url.ui_auth_url
  • Fetching data and interface fragments
    • fetch.fetch_data()
    • fetch.fetch_html()
  • DOM helpers
    • dom.inject_html()
    • dom.inject_node()
  • Instruments and filters
    • instrument.get_instruments()
    • instrument.get_instrumentID()
    • instrument.update_instrument()
    • instrument.get_filterID()
    • instrument.update_filter()
  • Calculator form
    • etc.update_etcform()
  • Transmission plots
    • plot.plot_filter()
  • Interface settings
    • settings.setup_theme_settings()
    • settings.setup_instrument_settings()
  • Themes
    • theme.themes
    • theme.theme_icons
    • theme.get_theme()
    • theme.update_theme()
  • Health monitoring
    • health.setup_health()