Skip to content

Commit

Permalink
Final Updates for XRTpy JOSS Submission - Part 3 (#271)
Browse files Browse the repository at this point in the history
* Correcting @DelZanna:2020 reference

* Adding DOI to Dere

* Fixing Sunpy reference

* Updating note

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fixing aas code spell

* Updating ignore-wors-list-adding aas

* Updating aas

* Fix spacing

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
joyvelasquez and pre-commit-ci[bot] authored Jul 31, 2024
1 parent 14f3638 commit 3f96d52
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 6 deletions.
24 changes: 20 additions & 4 deletions joss/paper.bib
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,26 @@ @ARTICLE{Dere:1997
author = {Dere, K. P. and Landi, E. and Mason, H. E. and Monsignori Fossi, B. C. and Young, P. R.},
title = "{CHIANTI - An Atomic Database For Emission Lines - Paper I: Wavelengths greater than 50 Å}",
journal = {Astronomy and Astrophysics Suppl. Set.},
keywords = {},
keywords = {ATOMIC DATA; ASTRONOMICAL DATA BASES: MISCELLANEOUS; ULTRAVIOLET: GENERAL; SUN: ATMOSPHERE; STARS: ATMOSPHERE},
year = {1997},
month = {},
month = {October},
volume = {125},
pages = {149-173},
doi = {10.1051/aas:1997368},
adsurl = {https://ui.adsabs.harvard.edu/abs/1997A&AS..125..149D/abstract},
adsnote = {Available from ADS}
}

@ARTICLE{Dere:1997,
author = {Dere, K. P. and Landi, E. and Mason, H. E. and Monsignori Fossi, B. C. and Young, P. R.},
title = "{CHIANTI - An Atomic Database For Emission Lines - Paper I: Wavelengths greater than 50 Å}",
journal = {Astronomy and Astrophysics Supplement Series},
keywords = {ATOMIC DATA; ASTRONOMICAL DATA BASES: MISCELLANEOUS; ULTRAVIOLET: GENERAL; SUN: ATMOSPHERE; STARS: ATMOSPHERE},
year = {1997},
month = {October},
volume = {125},
pages = {149-173},
doi = {10.1051/aas:1997368},
adsurl = {https://ui.adsabs.harvard.edu/abs/1997A&AS..125..149D/abstract},
adsnote = {Available from ADS}
}
Expand Down Expand Up @@ -185,14 +200,15 @@ @article{Scott:2015

@article{SunPy:2020,
title = {The SunPy Project: Open Source Development and Status of the Version 1.0 Core Package},
author = {SunPy Community and Barnes, Will T. and Bobra, Monica G. and Christe, Steven D. and Freij, Nabil and Hayes, Laura A. and Ireland, Jack and Mumford, Stuart and Perez-Suarez, David and Ryan, Daniel F. and Shih, Albert Y. and (Primary Paper Contributors) and Chanda, Prateek and Glogowski, Kolja and Hewett, Russell and Hughitt, V. Keith and Hill, Andrew and Hiware, Kaustubh and Inglis, Andrew and Kirk, Michael S. F. and Konge, Sudarshan and Mason, James Paul and Maloney, Shane Anthony and Murray, Sophie A. and Panda, Asish and Park, Jongyeob and Pereira, Tiago M. D. and Reardon, Kevin and Savage, Sabrina and Sipőcz, Brigitta M. and Stansby, David and Jain, Yash and Taylor, Garrison and Yadav, Tannmay and Rajul and Dang, Trung Kien and (Sunpy Contributors)},
author = {SunPy Community},
journal = {The Astrophysical Journal},
volume = {890},
pages = {68},
year = {2020},
doi = {10.3847/1538-4357/ab4f7a},
number = {1},
url = {https://ui.adsabs.harvard.edu/abs/2020ApJ...890...68S/abstract}
url = {https://ui.adsabs.harvard.edu/abs/2020ApJ...890...68S/abstract},
note = {Primary Paper Contributors: Will T. Barnes, Monica G. Bobra, Steven D. Christe, Nabil Freij, Laura A. Hayes, Jack Ireland, Stuart Mumford, David Perez-Suarez, Daniel F. Ryan, Albert Y. Shih. SunPy Contributors: Prateek Chanda, Kolja Glogowski, Russell Hewett, V. Keith Hughitt, Andrew Hill, Kaustubh Hiware, Andrew Inglis, Michael S. F. Kirk, Sudarshan Konge, James Paul Mason, Shane Anthony Maloney, Sophie A. Murray, Asish Panda, Jongyeob Park, Tiago M. D. Pereira, Kevin Reardon, Sabrina Savage, Brigitta M. Sipőcz, David Stansby, Yash Jain, Garrison Taylor, Tannmay Yadav, Rajul, Trung Kien Dang, and Sunpy Contributors}
}

@article{Weberg:2023,
Expand Down
2 changes: 1 addition & 1 deletion joss/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The package is structured into distinct modules, each serving a specific purpose

- `xrtpy.response.effective_area`: XRTpy's capability to calculate effective areas for various XRT filter channels, combined with CCD contamination layer thickness information, is crucial for understanding instrumental spectral responses, as depicted in \autoref{fig:Figure 1}.

- `xrtpy.response.temperature_response`: XRTpy provides the capability of computing the temperature response of all the XRT filter channels. It does this by relying on a spectral emission model, drawing from [@Narukage:2011] and [@Narukage:2014]. Users can choose from a range of CHIANTI abundance sets, including the default model with coronal abundances, hybrid, and photospheric options. \autoref{fig:Figure 2} shows XRTpy's temperature response calculations for all XRT filters across the different CHIANTI abundance sets. The CHIANTI database is described in [@Dere:1997] and the version used in XRTpy is CHIANTI version 10.0 [@Del_Zanna:2020]. Researchers have the flexibility to select the abundance model that best aligns with their research requirements.
- `xrtpy.response.temperature_response`: XRTpy provides the capability of computing the temperature response of all the XRT filter channels. It does this by relying on a spectral emission model, drawing from [@Narukage:2011] and [@Narukage:2014]. Users can choose from a range of CHIANTI abundance sets, including the default model with coronal abundances, hybrid, and photospheric options. \autoref{fig:Figure 2} shows XRTpy's temperature response calculations for all XRT filters across the different CHIANTI abundance sets. The CHIANTI database is described in [@Dere:1997] and the version used in XRTpy is CHIANTI version 10.0 [@DelZanna:2020]. Researchers have the flexibility to select the abundance model that best aligns with their research requirements.

- `xrtpy.response.temperature_from_filter_ratio`: This module contains the `temperature_from_filter_ratio` function, which derives temperature and emission measure maps for a pair of images using the filter ratio method. \autoref{fig:Figure 3} illustrates an example usage of this function.

Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,8 @@ ons,
sav,
te,
tne,
ue
ue,
aas
"""

[tool.pytest.ini_options]
Expand Down

0 comments on commit 3f96d52

Please sign in to comment.