Skip to content

Commit 32587fe

Browse files
authored
Merge pull request #43 from synthpop-galaxy/docs
Docs
2 parents a6f8c1b + 23d17ed commit 32587fe

File tree

9 files changed

+292
-21
lines changed

9 files changed

+292
-21
lines changed

docs/joss-paper.bib

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
@ARTICLE{Penny2013,
2+
author = {{Penny}, M.~T. and {Kerins}, E. and {Rattenbury}, N. and {Beaulieu}, J. -P. and {Robin}, A.~C. and {Mao}, S. and {Batista}, V. and {Calchi Novati}, S. and {Cassan}, A. and {Fouqu{\'e}}, P. and {McDonald}, I. and {Marquette}, J.~B. and {Tisserand}, P. and {Zapatero Osorio}, M.~R.},
3+
title = "{ExELS: an exoplanet legacy science proposal for the ESA Euclid mission - I. Cold exoplanets}",
4+
journal = {\mnras},
5+
keywords = {gravitational lensing: micro, planets and satellites: detection, stars: low-mass, planetary systems, Galaxy: bulge, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Cosmology and Nongalactic Astrophysics},
6+
year = 2013,
7+
month = sep,
8+
volume = {434},
9+
number = {1},
10+
pages = {2-22},
11+
doi = {10.1093/mnras/stt927},
12+
archivePrefix = {arXiv},
13+
eprint = {1206.5296},
14+
primaryClass = {astro-ph.EP},
15+
adsurl = {https://ui.adsabs.harvard.edu/abs/2013MNRAS.434....2P},
16+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
17+
}
18+
19+
@ARTICLE{Penny2019,
20+
author = {{Penny}, Matthew T. and {Gaudi}, B. Scott and {Kerins}, Eamonn and {Rattenbury}, Nicholas J. and {Mao}, Shude and {Robin}, Annie C. and {Calchi Novati}, Sebastiano},
21+
title = "{Predictions of the WFIRST Microlensing Survey. I. Bound Planet Detection Rates}",
22+
journal = {\apjs},
23+
keywords = {gravitational lensing: micro, planets and satellites: detection, space vehicles: instruments, Astrophysics - Earth and Planetary Astrophysics},
24+
year = 2019,
25+
month = mar,
26+
volume = {241},
27+
number = {1},
28+
eid = {3},
29+
pages = {3},
30+
doi = {10.3847/1538-4365/aafb69},
31+
archivePrefix = {arXiv},
32+
eprint = {1808.02490},
33+
primaryClass = {astro-ph.EP},
34+
adsurl = {https://ui.adsabs.harvard.edu/abs/2019ApJS..241....3P},
35+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
36+
}
37+
38+
@ARTICLE{Koshimoto2021,
39+
author = {{Koshimoto}, Naoki and {Baba}, Junichi and {Bennett}, David P.},
40+
title = "{A Parametric Galactic Model toward the Galactic Bulge Based on Gaia and Microlensing Data}",
41+
journal = {\apj},
42+
keywords = {Initial mass function, Gravitational microlensing, Galactic bulge, Milky Way disk, Milky Way Galaxy, 796, 672, 2041, 1050, 1054, Astrophysics - Astrophysics of Galaxies, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Solar and Stellar Astrophysics},
43+
year = 2021,
44+
month = aug,
45+
volume = {917},
46+
number = {2},
47+
eid = {78},
48+
pages = {78},
49+
doi = {10.3847/1538-4357/ac07a8},
50+
archivePrefix = {arXiv},
51+
eprint = {2104.03306},
52+
primaryClass = {astro-ph.GA},
53+
adsurl = {https://ui.adsabs.harvard.edu/abs/2021ApJ...917...78K},
54+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
55+
}
56+
57+
@ARTICLE{Sormani2022,
58+
author = {{Sormani}, Mattia C. and {Sanders}, Jason L. and {Fritz}, Tobias K. and {Smith}, Leigh C. and {Gerhard}, Ortwin and {Sch{\"o}del}, Rainer and {Magorrian}, John and {Neumayer}, Nadine and {Nogueras-Lara}, Francisco and {Feldmeier-Krause}, Anja and {Mastrobuono-Battisti}, Alessandra and {Schultheis}, Mathias and {Shahzamanian}, Banafsheh and {Vasiliev}, Eugene and {Klessen}, Ralf S. and {Lucas}, Philip and {Minniti}, Dante},
59+
title = "{Self-consistent modelling of the Milky Way's nuclear stellar disc}",
60+
journal = {\mnras},
61+
keywords = {Galaxy: centre, Galaxy: kinematics and dynamics, Galaxy: structure, Astrophysics - Astrophysics of Galaxies},
62+
year = 2022,
63+
month = may,
64+
volume = {512},
65+
number = {2},
66+
pages = {1857-1884},
67+
doi = {10.1093/mnras/stac639},
68+
archivePrefix = {arXiv},
69+
eprint = {2111.12713},
70+
primaryClass = {astro-ph.GA},
71+
adsurl = {https://ui.adsabs.harvard.edu/abs/2022MNRAS.512.1857S},
72+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
73+
}
74+
75+
@ARTICLE{Bachelet2024,
76+
author = {{Bachelet}, E. and {Hundertmark}, M. and {Calchi Novati}, S.},
77+
title = "{Estimating Microlensing Parameters from Observables and Stellar Isochrones with pyLIMASS}",
78+
journal = {\aj},
79+
keywords = {Gravitational microlensing, 672, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Astrophysics of Galaxies, Astrophysics - Solar and Stellar Astrophysics},
80+
year = 2024,
81+
month = jul,
82+
volume = {168},
83+
number = {1},
84+
eid = {24},
85+
pages = {24},
86+
doi = {10.3847/1538-3881/ad4862},
87+
archivePrefix = {arXiv},
88+
eprint = {2405.02230},
89+
primaryClass = {astro-ph.IM},
90+
adsurl = {https://ui.adsabs.harvard.edu/abs/2024AJ....168...24B},
91+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
92+
}
93+
94+
@ARTICLE{Johnson2020,
95+
author = {{Johnson}, Samson A. and {Penny}, Matthew and {Gaudi}, B. Scott and {Kerins}, Eamonn and {Rattenbury}, Nicholas J. and {Robin}, Annie C. and {Calchi Novati}, Sebastiano and {Henderson}, Calen B.},
96+
title = "{Predictions of the Nancy Grace Roman Space Telescope Galactic Exoplanet Survey. II. Free-floating Planet Detection Rates}",
97+
journal = {\aj},
98+
keywords = {Gravitational microlensing, Free floating planets, Space telescopes, Exoplanet detection methods, 672, 549, 1547, 489, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Astrophysics of Galaxies, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - Solar and Stellar Astrophysics},
99+
year = 2020,
100+
month = sep,
101+
volume = {160},
102+
number = {3},
103+
eid = {123},
104+
pages = {123},
105+
doi = {10.3847/1538-3881/aba75b},
106+
archivePrefix = {arXiv},
107+
eprint = {2006.10760},
108+
primaryClass = {astro-ph.EP},
109+
adsurl = {https://ui.adsabs.harvard.edu/abs/2020AJ....160..123J},
110+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
111+
}

docs/joss-paper.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: 'SynthPop: A New Framework for Synthetic Milky Way Population Generation'
3+
tags:
4+
- Python
5+
- astronomy
6+
- milky way
7+
- population synthesis
8+
authors:
9+
- name: Jonas Kl\"{u}ter
10+
orcid: 0000-0002-3469-5133
11+
equal-contrib: true
12+
affiliation: 1
13+
- name: Macy J. Huston
14+
orcid: 0000-0003-4591-3201
15+
equal-contrib: true
16+
affiliation: 2
17+
- name: Abigail Aronica
18+
affiliation: 3
19+
- name: Samson A. Johnson
20+
orcid: 0000-0001-9397-4768
21+
affiliation: "3, 4"
22+
- name: Matthew Penny
23+
orcid: 0000-0001-7506-5640
24+
affiliation: 1
25+
- name: Marz Newman
26+
orcid: 0009-0002-1973-5229
27+
affiliation: 1
28+
- name: Farzaneh Zohrabi
29+
orcid: 0000-0003-2872-9883
30+
affiliation: 1
31+
- name: Alison L. Crisp
32+
orcid: 0000-0003-4310-3440
33+
affiliation: 3
34+
- name: Allison Chevis
35+
orcid: 0000-0003-2558-1748
36+
affiliation: 5
37+
affiliations:
38+
- name: Department of Physics \& Astronomy, Louisiana State University, Baton Rouge, LA 70803, USA
39+
index: 1
40+
- name: Astronomy Department, University of California, Berkeley, CA, 94720, USA
41+
index: 2
42+
- name: Department of Astronomy, The Ohio State University, Columbus, OH 43210, USA
43+
index: 3
44+
- name: NASA Jet Propulsion Laboratory, Pasadena, CA, 91109, USA
45+
index: 4
46+
- name: Department of Physics, Pennsylvania State University, State College, PA 16802, USA
47+
index: 5
48+
date: 02 December 2024
49+
bibliography: joss-paper.bib
50+
51+
aas-doi: xx.xxxx/xxxxx
52+
aas-journal: xxxxxxx
53+
---
54+
55+
# Summary
56+
57+
SynthPop is a new open source, modular population synthesis Galactic modeling software to simulate catalogs of Milky Way stars along any sightline outward from the Sun.
58+
Motivated by a lack flexibility in existing Galactic models, SynthPop is coded entirely in python, can be run standalone or as an imported module, and is configured by json files that allow different model components to be switched out as desired.
59+
60+
# Statement of need
61+
62+
We have built SynthPop to address the need we perceived for a publicly available population synthesis code that can be easily modified, provides an interface that can be run via script, and ideally can allow comparisons between different models within a single framework. To achieve these goals, we built the package in python, which is likely the most widely used language in astronomy. This choice results in slower performance than a compiled language, but a minimal bar to code modification, and an easy way to import the package into other code. We have designed the package so that it can be modified either through the adjustment of parameter files or by adding new code modules to achieve results that are not enabled by existing tools.
63+
64+
The primary driving use case for SynthPop is to provide synthetic stellar population catalogs for microlensing simulations (@Penny2013, @Penny2019, @Johnson2020).
65+
66+
# Ongoing use
67+
68+
Huston et al. (in prep.) will illustrate the development of a SynthPop Model version that matches well to data, and apply the model to the Roman Galactic Bulge Time Domain Survey to explore the Galactic distributions of anticipated microlensing event lenses and sources.
69+
This model version is also being used as the Galactic model input for gulls (@Penny2013, @Penny2019) and PyLIMASS (@Bachelet2024) by the Roman Galactic Exoplanet Survey Project Infrastructure Team for updated exoplanet mass yield estimates and field optimization (Terry et al., in prep.; Zohrabi et al., in prep.).
70+
71+
# Acknowledgements
72+
73+
We appreciate conversations with N. Koshimoto in implementing the (@Koshimoto2021) model and (@Sormani2022) nuclear stellar disk into SynthPop.
74+
We also thank the Roman Galactic Exoplanet Survey Project Infrastructure team members and others who helped improve the software through discussions, use during development, and feedback.
75+
76+
J.K. acknowledges support from NASA award NNX16AC62G and the Gordon and Betty Moore Foundation award GBMF10467.
77+
78+
M.J.H. acknowledges support from the Heising-Simons Foundation under grant No. 2022-3542.
79+
Early work on this software by M.J.H. and A.A. was supported by the Ohio State University Summer Undergraduate Research Program.
80+
81+
S.A.J.’s work was supported by NASA Grant 80NSSC24M0022 and an appointment to the NASA Postdoctoral Program at the NASA Jet Propulsion Laboratory, administered by Oak Ridge Associated Universities under contract with NASA.
82+
83+
M.T.P. acknowledges support from NASA awards NNX14AF63G, NNX16AC62G, 80NSSC24M0022, 80NSSC24K0881, and Louisiana Board of Regents Support Fund (RCS Award Contract Simple: LEQSF(2020-23)-RD-A-10).
84+
Early work by M.T.P. was performed in part under contract with the Jet Propulsion Laboratory (JPL) funded by NASA through the Sagan Fellowship Program executed by the NASA Exoplanet Science Institute.
85+
86+
M.N. acknowledges support from NASA award 80NSSC24K0881.
87+
A.L.C. and F.Z. acknowledge support from NASA grant 80NSSC24M0022.
88+
A.C.'s work was supported by the National Science Foundation under Grant Number 1852454.
89+
Portions of this research were conducted with high performance computational resources provided by Louisiana State University ([http://www.hpc.lsu.edu](http://www.hpc.lsu.edu)).
90+
91+
# References

docs/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
sphinx==7.1.2
2-
sphinx-rtd-theme==1.3.0rc1
1+
sphinx
2+
sphinx-rtd-theme
33
sphinx-autoapi

docs/source/conf.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
sys.path.insert(0, os.path.abspath('../../synthpop/'))
88
sys.path.insert(0, os.path.abspath('../'))
99
sys.path.insert(0, os.path.abspath('../../'))
10-
sys.path.insert(0, os.path.abspath('../../synthpop/_modules/'))
11-
sys.path.insert(0, os.path.abspath('../../synthpop/_modules/age/'))
12-
sys.path.insert(0, os.path.abspath('../../synthpop/_modules/metallicity/'))
10+
sys.path.insert(0, os.path.abspath('../../synthpop/modules/'))
11+
sys.path.insert(0, os.path.abspath('../../synthpop/modules/age/'))
12+
sys.path.insert(0, os.path.abspath('../../synthpop/modules/metallicity/'))
1313

1414
#import migrate_interactive_part
1515
#migrate_interactive_part.migrate('../../synthpop')
@@ -34,7 +34,7 @@
3434

3535
extensions.append('autoapi.extension')
3636
extensions.append('sphinx.ext.autosectionlabel')
37-
autoapi_dirs = ['../../synthpop','../../synthpop/_modules/']
37+
autoapi_dirs = ['../../synthpop','../../synthpop/modules/']
3838
autoapi_ignore = ['conf.py']
3939

4040
intersphinx_mapping = {
@@ -48,6 +48,7 @@
4848
# -- Options for HTML output
4949

5050
html_theme = 'sphinx_rtd_theme'
51+
html_css_files = ["custom.css"]
5152

5253
# -- Options for EPUB output
5354
epub_show_urls = 'footnote'

docs/source/configuration.rst

Lines changed: 71 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ example::
100100
"l_set_type":"list",
101101
"b_set":[-1,0,1],
102102
"b_set_type":"list",
103-
"solid_angle": 1e-2,
103+
"solid_angle": 1e-2,
104104
"solid_angle_unit": "deg^2"
105105
}
106106

@@ -169,9 +169,14 @@ POPULATION_GENERATION
169169

170170
**mass_lims**: range of initial stellar masses to produce
171171

172-
**N_mc_totmass**: number of stars to use to estimate number of stars needed per slice
172+
**N_mc_totmass**: number of random points to sample to estimate average density in a slice
173173

174-
**lost_mass_option**: method to estimate correction for mass loss
174+
**lost_mass_option**: method to estimate correction for mass loss with four integer options:
175+
176+
* 1: For each population, a test batch of N_av_mass stars is generated and evolved to estimate the total initial stellar mass required to meet the desired present day total stellar mass. These values are saved for all sightlines run with the initialized populations.
177+
* 2: For each population a test batch of N_av_mass stars is generated and evolved to estimate the total initial stellar mass required to meet the desired present day total stellar mass. These value is re-calculated for each sightline run.
178+
* 3: Initially treat the population density as an initial mass density, then add or remove stars as needed.
179+
* 4: Use the precomputed value given by either "av_mass_corr" or "n_star_corr" in each population file to scale the required total initial stellar mass needed to achieve the desired present day total stellar mass.
175180

176181
**N_av_mass**: number of stars to use to estimate average evolved stellar mass
177182

@@ -210,10 +215,8 @@ EXTINCTION_MAP
210215
**extinction_law_kwargs**: dictionary containing:
211216

212217
* **name**: name of extinction law module
218+
* **R_V**: total to selective extinction ratio [note: only used in select extinction laws, will be ignored if input for others]
213219
* **<kwargs>**: any kwargs required or optional for the selected module
214-
[Note: multi-evolution class options are available]
215-
216-
**R_V**: total to selective extinction ratio [note: only used in select extinction laws]
217220

218221
example::
219222

@@ -224,9 +227,8 @@ example::
224227
},
225228
"extinction_law_kwargs":
226229
[
227-
{"name":"SODC"}
228-
],
229-
"R_V":2.5
230+
{"name":"SODC", "R_V":2.5}
231+
]
230232
},
231233

232234
ISOCHRONE_INTERPOLATION
@@ -271,12 +273,71 @@ PHOTOMETRIC_OUTPUTS
271273

272274
**chosen_bands**: list of filters to include for synthetic photometry
273275

276+
For the MIST evolution module, the following filters are available:
277+
278+
.. list-table::
279+
:widths: 20 80
280+
:header-rows: 1
281+
282+
* - System
283+
- Filters (use the names as written here)
284+
* - CFHT
285+
- CFHT_u, CFHT_CaHK, CFHT_g, CFHT_r, CFHT_i_new, CFHT_i_old, CFHT_z
286+
* - DECam
287+
- DECam_u, DECam_g, DECam_r, DECam_i, DECam_z, DECam_Y
288+
* - GALEX
289+
- GALEX_FUV, GALEX_NUV
290+
* - HST_ACSHR
291+
- ACS_HRC_F220W, ACS_HRC_F250W, ACS_HRC_F330W, ACS_HRC_F344N, ACS_HRC_F435W, ACS_HRC_F475W, ACS_HRC_F502N, ACS_HRC_F550M, ACS_HRC_F555W, ACS_HRC_F606W, ACS_HRC_F625W, ACS_HRC_F658N, ACS_HRC_F660N, ACS_HRC_F775W, ACS_HRC_F814W, ACS_HRC_F850LP, ACS_HRC_F892N
292+
* - HST_ACSWF
293+
- ACS_WFC_F435W, ACS_WFC_F475W, ACS_WFC_F502N, ACS_WFC_F550M, ACS_WFC_F555W, ACS_WFC_F606W, ACS_WFC_F625W, ACS_WFC_F658N, ACS_WFC_F660N, ACS_WFC_F775W, ACS_WFC_F814W, ACS_WFC_F850LP, ACS_WFC_F892N
294+
* - HST_WFC3
295+
- WFC3_UVIS_F200LP, WFC3_UVIS_F218W, WFC3_UVIS_F225W, WFC3_UVIS_F275W, WFC3_UVIS_F280N, WFC3_UVIS_F300X, WFC3_UVIS_F336W, WFC3_UVIS_F343N, WFC3_UVIS_F350LP, WFC3_UVIS_F373N, WFC3_UVIS_F390M, WFC3_UVIS_F390W, WFC3_UVIS_F395N, WFC3_UVIS_F410M, WFC3_UVIS_F438W, WFC3_UVIS_F467M, WFC3_UVIS_F469N, WFC3_UVIS_F475W, WFC3_UVIS_F475X, WFC3_UVIS_F487N, WFC3_UVIS_F502N, WFC3_UVIS_F547M, WFC3_UVIS_F555W, WFC3_UVIS_F600LP, WFC3_UVIS_F606W, WFC3_UVIS_F621M, WFC3_UVIS_F625W, WFC3_UVIS_F631N, WFC3_UVIS_F645N, WFC3_UVIS_F656N, WFC3_UVIS_F657N, WFC3_UVIS_F658N, WFC3_UVIS_F665N, WFC3_UVIS_F673N, WFC3_UVIS_F680N, WFC3_UVIS_F689M, WFC3_UVIS_F763M, WFC3_UVIS_F775W, WFC3_UVIS_F814W, WFC3_UVIS_F845M, WFC3_UVIS_F850LP, WFC3_UVIS_F953N, WFC3_IR_F098M, WFC3_IR_F105W, WFC3_IR_F110W, WFC3_IR_F125W, WFC3_IR_F126N, WFC3_IR_F127M, WFC3_IR_F128N, WFC3_IR_F130N, WFC3_IR_F132N, WFC3_IR_F139M, WFC3_IR_F140W, WFC3_IR_F153M, WFC3_IR_F160W, WFC3_IR_F164N, WFC3_IR_F167N
296+
* - HST_WFPC2
297+
- WFPC2_F218W, WFPC2_F255W, WFPC2_F300W, WFPC2_F336W, WFPC2_F439W, WFPC2_F450W, WFPC2_F555W, WFPC2_F606W, WFPC2_F622W, WFPC2_F675W, WFPC2_F791W, WFPC2_F814W, WFPC2_F850LP
298+
* - IPHAS
299+
- INT_IPHAS_gR, INT_IPHAS_Ha, INT_IPHAS_gI
300+
* - JWST
301+
- F070W, F090W, F115W, F140M, F150W2, F150W, F162M, F164N, F182M, F187N, F200W, F210M, F212N, F250M, F277W, F300M, F322W2, F323N, F335M, F356W, F360M, F405N, F410M, F430M, F444W, F460M, F466N, F470N, F480M
302+
* - LSST
303+
- LSST_u, LSST_g, LSST_r, LSST_i, LSST_z, LSST_y
304+
* - PanSTARRS
305+
- PS_g, PS_r, PS_i, PS_z, PS_y, PS_w, PS_open
306+
* - SDSSugriz
307+
- SDSS_u, SDSS_g, SDSS_r, SDSS_i, SDSS_z
308+
* - SkyMapper
309+
- SkyMapper_u, SkyMapper_v, SkyMapper_g, SkyMapper_r, SkyMapper_i, SkyMapper_z
310+
* - SPITZER
311+
- IRAC_3.6, IRAC_4.5, IRAC_5.8, IRAC_8.0
312+
* - HSC
313+
- hsc_g, hsc_r, hsc_i, hsc_z, hsc_y, hsc_nb816, hsc_nb921
314+
* - Swift
315+
- Swift_UVW2, Swift_UVM2, Swift_UVW1, Swift_U, Swift_B, Swift_V
316+
* - UBVRIplus
317+
- Bessell_U, Bessell_B, Bessell_V, Bessell_R, Bessell_I, 2MASS_J, 2MASS_H, 2MASS_Ks, Kepler_Kp, Kepler_D51, Hipparcos_Hp, Tycho_B, Tycho_V, Gaia_G_DR2Rev, Gaia_BP_DR2Rev, Gaia_RP_DR2Rev, Gaia_G_MAW, Gaia_BP_MAWb, Gaia_BP_MAWf, Gaia_RP_MAW, TESS, Gaia_G_EDR3, Gaia_BP_EDR3, Gaia_RP_EDR3
318+
* - UKIDSS
319+
- UKIDSS_Z, UKIDSS_Y, UKIDSS_J, UKIDSS_H, UKIDSS_K
320+
* - VISTA
321+
- VISTA_Z, VISTA_Y, VISTA_J, VISTA_H, VISTA_Ks
322+
* - WashDD0uvby
323+
- Washington_C, Washington_M, Washington_T1, Washington_T2, DDO51_vac, DDO51_f31, Stromgren_u, Stromgren_v, Stromgren_b, Stromgren_y
324+
* - WFIRST
325+
- R062, Z087, Y106, J129, W146, H158, F184
326+
* - WISE
327+
- WISE_W1, WISE_W2, WISE_W3, WISE_W4
328+
* - SPLUS
329+
- SPLUS_uJAVA, SPLUS_gSDSS, SPLUS_rSDSS, SPLUS_iSDSS, SPLUS_zSDSS, SPLUS_J0340, SPLUS_J0378, SPLUS_J0395, SPLUS_J0410, SPLUS_J0515, SPLUS_J0660, SPLUS_J0861
330+
* - UVIT
331+
- UVIT_F148W, UVIT_F154W, UVIT_F169M, UVIT_F172M, UVIT_N242W, UVIT_N219M, UVIT_N245M, UVIT_N263M, UVIT_N279N
332+
274333
**eff_wavelengths**: dictionary specifying effective wavelength for each chosen filter [Note: use option {"json_file":"AAA_effective_wavelengths.json"} to load these from a pre-existing file]
275334

276335
**obs_mag**: boolean option to generate observed magnitudes (generates absolute magnitudes if set to false)
277336

278337
**opt_iso_props**: optional stellar properties to save, with original column names from isochrones
279338

339+
For MIST isochrone stellar property options, see `their documentation here <https://waps.cfa.harvard.edu/MIST/README_tables.pdf>`_
340+
280341
**col_names**: columns names for output for the columns determined in **opt_iso_props**
281342

282343
example::
@@ -302,7 +363,7 @@ OUTPUT
302363

303364
**output_filename_pattern**: string describing naming system for output files. Accessible values are model_base_name (str), model_name (str), l_deg (float), b_deg(float), solid_angle (float), date (datetime.date object), time (datetime.time object).
304365

305-
**output_file_type**: list containing output file type and dictionary for additional kwargs
366+
**output_file_type**: list containing output file type and dictionary for additional kwargs, saved via pandas or astropy. valid options: csv, json, html, xml, excel, hdf5, feather, parquet, stata, pickle, sql, fits, vot
306367

307368
**overwrite**: boolean option to overwrite existing output files of the same name
308369

0 commit comments

Comments
 (0)