File: reference.rst

package info (click to toggle)
sncosmo 2.12.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,628 kB
  • sloc: python: 7,278; cpp: 184; makefile: 130; sh: 1
file content (146 lines) | stat: -rw-r--r-- 2,031 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

***************
Reference / API
***************

.. currentmodule:: sncosmo

Model & Components
==================

.. autosummary::
   :toctree: api

   Model

*Source component of Model*

.. autosummary::
   :toctree: api

   Source
   TimeSeriesSource
   StretchSource
   MLCS2k2Source
   SALT2Source
   SALT3Source
   SNEMOSource
   SUGARSource
   
*Effect components of Model: interstellar dust extinction*

.. autosummary::
   :toctree: api

   PropagationEffect
   CCM89Dust
   OD94Dust
   F99Dust

Bandpass & Magnitude Systems
============================

.. autosummary::
   :toctree: api

   Bandpass
   AggregateBandpass
   BandpassInterpolator
   MagSystem
   ABMagSystem
   SpectralMagSystem
   CompositeMagSystem

I/O
===

*Functions for reading and writing photometric data, gridded data, extinction
maps, and more.*

.. autosummary::
   :toctree: api

   read_lc
   write_lc
   read_bandpass
   load_example_data
   load_example_spectrum_data
   read_snana_ascii
   read_snana_fits
   read_snana_simlib
   read_griddata_ascii
   read_griddata_fits
   write_griddata_ascii
   write_griddata_fits

Spectra
=======

.. autosummary::
   :toctree: api

   Spectrum


.. _fitting-api:

Fitting Photometric Data
========================

*Estimate model parameters from photometric data*

.. autosummary::
   :toctree: api

   fit_lc
   mcmc_lc
   nest_lc

*Convenience functions*

.. autosummary::
   :toctree: api

   select_data
   chisq
   flatten_result

Plotting
========

*Convenience functions for quick standard plots (requires matplotlib)*

.. autosummary::
   :toctree: api

   plot_lc

Simulation
==========

.. autosummary::
   :toctree: api

   zdist
   realize_lcs

Registry
========

*Register and retrieve custom built-in sources, bandpasses, and
magnitude systems*

.. autosummary::
   :toctree: api

   register
   register_loader
   get_source
   get_bandpass
   get_magsystem

Class Inheritance Diagrams
==========================

.. inheritance-diagram:: models magsystems bandpasses
   :parts: 1