What do I reference?

This notebook shows you how to get the references you need based on: - your full_output data bundle - specified molecules - specified methods (e.g. 1d spectra vs climate)

[1]:
import picaso.justdoit as jdi
import picaso.references as pref

Let’s set up a quick little model run so that we can see how the reference function works

[2]:
opa = jdi.opannection(wave_range=[0.3,1]) #lets just use all defaults
planet=jdi.inputs()
planet.phase_angle(0) #radians
planet.gravity(gravity=25, gravity_unit=jdi.u.Unit('m/(s**2)')) #any astropy units available
planet.star(opa, 5000,0,4.0) #opacity db, pysynphot database, temp, metallicity, logg
planet.atmosphere(filename=jdi.jupiter_pt(), sep='\s+')
full_output=planet.spectrum(opa, full_output=True)

Get opacity data references based on model output

[3]:
refs = pref.References()
opa_latex, bibdb = refs.get_opa(full_output=full_output['full_output'])
WARNING:root:Unknown block type <class 'bibtexparser.model.DuplicateBlockKeyBlock'>
WARNING:root:Unknown block type <class 'bibtexparser.model.DuplicateBlockKeyBlock'>
WARNING:root:Unknown block type <class 'bibtexparser.model.DuplicateBlockKeyBlock'>
[4]:
print(opa_latex)

        \begin{table*}
        \centering
        \begin{tabular}{c|c}
        H2 &  \citet{HITRAN2016} \\
        VO &  \citet{McKemmish16,GharibNezhad2021} \\
        TiO &  \citet{McKemmish2019TiO,GharibNezhad2021} \\
        CO2 &  \citet{HUANG2014reliable} \\
        H2O &  \citet{Polyansky2018H2O} \\
        CH4 &  \citet{yurchenko13vibrational,yurchenko_2014} \\
        CO &  \citet{HITEMP2010,HITRAN2016,li15rovibrational} \\
        NH3 &  \citet{yurchenko11vibrationally,Wilzewski16} \\
        N2 &  \citet{hitran2012} \\
        PH3 &  \citet{sousa14exomol} \\
        H2--H2 &  \citet{Saumon12,Lenzuni1991h2h2} \\
        H2--He &  \citet{Saumon12} \\
        H2--N2 &  \citet{Saumon12} \\
        H2--H &  \citet{Saumon12} \\
        H2--CH4 &  \citet{Saumon12} \\
        H-bf &  \citet{Bell1987Hff} \\
        H2- &  \citet{bell1980free} \\

            \end{tabular}
            \caption{Line lists used to make PICASO Opacities}
            \label{tab:opas}
        \end{table*}

[5]:
bibdb.entries[0:2]
[5]:
[Entry(entry_type=`inproceedings`, key=`HITRAN2016`, fields=`[Field(key=`author`, value=`{Gordon}, Iouli E. and {Rothman}, Laurence S. and {Tan}, Yan and {Kochanov}, Roman V. and {Hill}, Christian`, start_line=98), Field(key=`title`, value=`{HITRAN2016: Part I. Line lists for H\_2O, CO\_2, O\_3, N\_2O, CO, CH\_4, and O\_2}`, start_line=99), Field(key=`keywords`, value=`Linelists`, start_line=100), Field(key=`booktitle`, value=`72nd International Symposium on Molecular Spectroscopy`, start_line=101), Field(key=`year`, value=`2017`, start_line=102), Field(key=`month`, value=`jun`, start_line=103), Field(key=`eid`, value=`TJ08`, start_line=104), Field(key=`pages`, value=`TJ08`, start_line=105), Field(key=`doi`, value=`10.15278/isms.2017.TJ08`, start_line=106), Field(key=`adsurl`, value=`https://ui.adsabs.harvard.edu/abs/2017isms.confETJ08G`, start_line=107), Field(key=`adsnote`, value=`Provided by the SAO/NASA Astrophysics Data System`, start_line=108)]`, start_line=97),
 Entry(entry_type=`article`, key=`McKemmish16`, fields=`[Field(key=`author`, value=`{McKemmish}, Laura K. and {Yurchenko}, Sergei N. and
          {Tennyson}, Jonathan`, start_line=647), Field(key=`title`, value=`{ExoMol line lists - XVIII. The high-temperature spectrum of VO}`, start_line=649), Field(key=`journal`, value=`\mnras`, start_line=650), Field(key=`keywords`, value=`molecular data, opacity, astronomical data bases: miscellaneous, planets and satellites: atmospheres, brown dwarfs, stars: low-mass, Astrophysics - Solar and Stellar Astrophysics, Physics - Chemical Physics`, start_line=651), Field(key=`year`, value=`2016`, start_line=652), Field(key=`month`, value=`nov`, start_line=653), Field(key=`volume`, value=`463`, start_line=654), Field(key=`number`, value=`1`, start_line=655), Field(key=`pages`, value=`771-793`, start_line=656), Field(key=`doi`, value=`10.1093/mnras/stw1969`, start_line=657), Field(key=`archivePrefix`, value=`arXiv`, start_line=658), Field(key=`eprint`, value=`1609.06120`, start_line=659), Field(key=`primaryClass`, value=`astro-ph.SR`, start_line=660), Field(key=`adsurl`, value=`https://ui.adsabs.harvard.edu/abs/2016MNRAS.463..771M`, start_line=661), Field(key=`adsnote`, value=`Provided by the SAO/NASA Astrophysics Data System`, start_line=662)]`, start_line=646)]

Write to bibtex file

[6]:
pref.create_bib(bibdb, 'molecule.bib')
WARNING:root:Unknown block type <class 'bibtexparser.model.DuplicateBlockKeyBlock'>
WARNING:root:Unknown block type <class 'bibtexparser.model.DuplicateBlockKeyBlock'>
WARNING:root:Unknown block type <class 'bibtexparser.model.DuplicateBlockKeyBlock'>
WARNING:root:Unknown block type <class 'bibtexparser.model.DuplicateBlockKeyBlock'>
WARNING:root:Unknown block type <class 'bibtexparser.model.DuplicateBlockKeyBlock'>
WARNING:root:Unknown block type <class 'bibtexparser.model.DuplicateBlockKeyBlock'>

Get opacity data references for certain molecules

[7]:
opa_latex, bibdb = refs.get_opa(molecules=['H2O','CO2'])
[8]:
print(opa_latex)

        \begin{table*}
        \centering
        \begin{tabular}{c|c}
        H2O &  \citet{Polyansky2018H2O} \\
        CO2 &  \citet{HUANG2014reliable} \\

            \end{tabular}
            \caption{Line lists used to make PICASO Opacities}
            \label{tab:opas}
        \end{table*}

[9]:
bibdb.entries
[9]:
[Entry(entry_type=`article`, key=`Polyansky2018H2O`, fields=`[Field(key=`author`, value=`{Polyansky}, Oleg L. and {Kyuberis}, Aleksandra A. and {Zobov}, Nikolai F. and {Tennyson}, Jonathan and {Yurchenko}, Sergei N. and {Lodi}, Lorenzo`, start_line=203), Field(key=`title`, value=`{ExoMol molecular line lists XXX: a complete high-accuracy line list for water}`, start_line=204), Field(key=`journal`, value=`\mnras`, start_line=205), Field(key=`keywords`, value=`molecular data; opacity; planets and satellites: atmospheres; stars: atmospheres; stars: low-mass, stars: brown dwarfs. astronomical data bases: miscellaneous, Astrophysics - Earth and Planetary Astrophysics, Astrophysics - Solar and Stellar Astrophysics, Physics - Chemical Physics`, start_line=206), Field(key=`year`, value=`2018`, start_line=207), Field(key=`month`, value=`oct`, start_line=208), Field(key=`volume`, value=`480`, start_line=209), Field(key=`number`, value=`2`, start_line=210), Field(key=`pages`, value=`2597-2608`, start_line=211), Field(key=`doi`, value=`10.1093/mnras/sty1877`, start_line=212), Field(key=`archivePrefix`, value=`arXiv`, start_line=213), Field(key=`eprint`, value=`1807.04529`, start_line=214), Field(key=`primaryClass`, value=`astro-ph.EP`, start_line=215), Field(key=`adsurl`, value=`https://ui.adsabs.harvard.edu/abs/2018MNRAS.480.2597P`, start_line=216), Field(key=`adsnote`, value=`Provided by the SAO/NASA Astrophysics Data System`, start_line=217)]`, start_line=202),
 Entry(entry_type=`article`, key=`HUANG2014reliable`, fields=`[Field(key=`title`, value=`Reliable infrared line lists for 13 CO2 isotopologues up to E′=18,000cm−1 and 1500K, with line shape parameters`, start_line=412), Field(key=`journal`, value=`Journal of Quantitative Spectroscopy and Radiative Transfer`, start_line=413), Field(key=`volume`, value=`147`, start_line=414), Field(key=`pages`, value=`134 - 144`, start_line=415), Field(key=`year`, value=`2014`, start_line=416), Field(key=`issn`, value=`0022-4073`, start_line=417), Field(key=`doi`, value=`https://doi.org/10.1016/j.jqsrt.2014.05.015`, start_line=418), Field(key=`url`, value=`http://www.sciencedirect.com/science/article/pii/S0022407314002246`, start_line=419), Field(key=`author`, value=`Xinchuan {Huang} and Robert R. Gamache and Richard S. Freedman and David W. Schwenke and Timothy J. Lee`, start_line=420), Field(key=`keywords`, value=`Carbon dioxide (CO), Isotopologues, IR line list, Line shape, Refined potential energy surface, Partition sum`, start_line=421), Field(key=`abstract`, value=`Reliable infrared (IR) line lists are reported for the 13 isotopologues of carbon dioxide in HITRAN notation: 626, 636, 628, 627, 828, 727, 827, 638, 637, 737, 838, 738, and 646. Three IR lists are available for each istotopologue: a complete list at 296K, a reduced-size list at 296K, plus a reduced-size list at 1000K. They are denoted Ames-296K, Ames-296K.reduced and Ames-1000K.reduced. With J up to 150, and energy up to 18,000cm−1 above the zero point energy, these lists are expected to cover the temperature range up to 1500K. Line shape parameters including temperature dependence are calculated and reported for four temperature ranges: Mars, Earth, Venus, and Hotter (700–2000K). Comparisons are made against the available transition data in the HITRAN2012 models. Line position accuracy for most transitions up to 10,000–13,000cm−1 is better than 0.03–0.05cm−1. Computed transition intensities agree well with most HITRAN data but there exist suspicious exceptions for isotopologues. These line lists will expedite CO2 IR experimental data analysis and provide the scientific community with trustworthy alternatives for unknown IR bands. These line lists may be combined with existing experimental databases to facilitate the analysis of future laboratory experiments or astronomical observations.`, start_line=422)]`, start_line=411)]