API reference

This reference is generated automatically from the docstrings in the source, organized by module. The most commonly used objects are re-exported at the top level of the lazuli_exo package, so lazuli_exo.observe and lazuli_exo.observe.observe both work.

Note

The runtime is terse: several helpers carry no docstring and are documented here by signature alone. The narrative explanation of what each subsystem computes lives in the User guide.

Top-level public API

observe	Simulate observing showcase planet under scenario for n_transits.
simulate	Simulate any transiting planet from a parameter dict.
SimulatedSpectrum
list_planets
list_scenarios	Scenarios every showcase planet supports (presets.SCENARIOS).

Showcase tables

• Observations (lazuli_exo.observe)
  • SimulatedSpectrum
  • positive_int()
  • observe()
• Detection statistic (lazuli_exo.detect)
  • detect_features()
• Light curves (lazuli_exo.lightcurve)
  • LightCurveSet
  • transit_flux()
  • light_curves()
• Binning (lazuli_exo.binning)
  • constant_R_edges()
  • bin_centers()
  • bin_model()
  • bin_sigma()
  • channel_edges()
  • R_instr()
  • snap_edges_to_channels()
  • instrument_response()
  • bin_weighted()
  • bin_observation()
• Lookup tables (lazuli_exo.tables)
  • slugify()
  • resolve_tables_dir()
  • write_model_table()
  • write_star_table()
  • write_noise_table()
  • write_ld_table()
  • write_zeta_grid()
  • load_zeta_grid()
  • write_phoenix_grid()
  • load_phoenix_grid()
  • load_model()
  • load_star()
  • load_noise()
  • load_ld()
  • sha256_file()
  • rebuild_index()
  • load_index()
  • list_planets()
  • list_scenarios()
• Target registry (lazuli_exo.targets)
  • get_target()
• Plotting (lazuli_exo.plotting)
  • wavelength_axis()
  • plot_spectrum()
  • plot_noise()
  • plot_light_curves()

Parametric model

• Assembler (lazuli_exo.simulate)
  • simulate()
• Parametric atmosphere (lazuli_exo.atmosphere)
  • grid_wavelengths()
  • transmission_depth()
• Stellar SEDs (lazuli_exo.star)
  • phoenix_sed()
  • contamination()
• Live noise via slicersim (lazuli_exo.slicer)
  • vega_to_ab_offset()
  • normalize_setup()
  • zodi_scale_from_ab_mag()
  • pixel_average_sed()
  • clear_noise_cache()
  • depth_error()
• Showcase presets (lazuli_exo.presets)
  • showcase()
• Orbital geometry (lazuli_exo.orbit)
  • transit_duration_s()
  • projected_separation()

Transit models

• Transit models (lazuli_exo.transit)
  • FluxModel
  • TransitModel
  • plot_flux_model()
  • download_exoplanet_archive()
  • load_exoplanet_archive()
  • default_archive_path()
  • FluxModel
  • TransitModel
  • ARCHIVE_COLUMNS
  • default_archive_path()
  • load_exoplanet_archive()
  • download_exoplanet_archive()
  • plot_flux_model()

Web layer

• Web forms (lazuli_exo.forms)
  • ParseResult
  • parse()
  • to_params()
  • from_preset()
• JSON reports (lazuli_exo.report)
  • derived_rows()
  • summary()