Skip to content

Commit

Permalink
updates based on JOSS review and fixing broken link
Browse files Browse the repository at this point in the history
  • Loading branch information
karllark committed Jul 29, 2024
1 parent 47c4f96 commit cb29df6
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 9 deletions.
4 changes: 1 addition & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -164,12 +164,10 @@ contributors who will abide by the `Python Software Foundation Code of Conduct
`Astropy`_. The following pages will help you get started with contributing
fixes, code, or documentation (no git or GitHub experience necessary):

* `How to make a code contribution <https://docs.astropy.org/en/stable/development/workflow/development_workflow.html>`_
* `How to make a code contribution <https://docs.astropy.org/en/latest/index_dev.html>`_

* `Coding Guidelines <https://docs.astropy.org/en/stable/development/codeguide.html>`_

* `Developer Documentation <https://docs.astropy.org/en/latest/index_dev.html>`_

For the complete list of contributors please see the `dust_extinction
contributors page on Github
<https://github.com/karllark/dust_extinction/graphs/contributors>`_.
Expand Down
12 changes: 12 additions & 0 deletions paper/paper.bib
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,18 @@ @ARTICLE{Astropy22
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@software{Barbary16,
author = {{Barbary}, Kyle},
title = "{extinction v0.3.0}",
year = 2016,
month = dec,
eid = {10.5281/zenodo.804967},
doi = {10.5281/zenodo.804967},
publisher = {Zenodo},
adsurl = {https://ui.adsabs.harvard.edu/abs/2016zndo....804967B},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

@ARTICLE{Bastiaansen92,
author = {{Bastiaansen}, P.~A.},
title = "{Narrow band multicolor photometry of reddened and unreddened early-type stars.}",
Expand Down
16 changes: 10 additions & 6 deletions paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,21 @@ in one place with a consistent interface.
Many observation- and theory-based extinction curves have been presented
in the literature. Having one python package providing these models ensures
that they are straightforward to use and used within their valid wavelength
and parameter (where appropriate) ranges.
and parameter (where appropriate) ranges. Other packages provide extinction
curves, but they generally provide one or a small number of curves for
specialized purposes [e.g., @Barbary16].

The types of extinction models supported are Averages, Parameter Averages, Grain
Models, and Shapes. The Averages are averages of a set of measured extinction
curves and examples are shown in Fig. \autoref{fig:averages}. The Parameter
curves and examples are shown in \autoref{fig:averages}. The Parameter
Averages are extinction curve averages that depend on a parameter, often $R(V) =
A(V)/E(B-V)$ which is the ratio of total to selective extinction. Fig.
A(V)/E(B-V)$ which is the ratio of total to selective extinction.
\autoref{fig:parameter_averages} shows examples of such models. The Grain
Models are those extinction curves computed using dust grain models. See Fig.
Models are those extinction curves computed using dust grain models. See
\autoref{fig:grain} and note that these models provide dust extinction
predictions from X-ray through submm wavelengths. The final type of models
are Shapes that provide flexible functional forms that fit selected wavelength
ranges (see Fig. \autoref{fig:shapes} for an example).
ranges (see \autoref{fig:shapes} for an example).

![Examples of Average models based on observations in the Milky Way, Large Magellanic Cloud (LMC), and Small Magellanic Cloud (SMC) [@Bastiaansen92; @Gordon03; @Gordon09; @Gordon21; @Gordon24].\label{fig:averages}](average_models_uv_nir.png){
width=70% }
Expand All @@ -68,7 +70,7 @@ a helper `extinguish` function that alternatively provides the fractional
effects of extinction for a specific dust column (e.g., $A(V)$ value). This
allows for the effects of dust to be modeled for or removed from an observation.

This package does not implement dust attenuation models. Dust attenuation
This package does not implement dust attenuation models[^1]. Dust attenuation
results when observing more complex systems like a star with nearby,
circumstellar dust or a galaxy with many stars extinguished by different amounts
of dust. In both cases, the wavelength dependence of effects of dust are
Expand All @@ -77,6 +79,8 @@ dust radiative transfer [@Steinacker13]. Specifically, these effects are the ave
extinguished by differing amount of dust and the inclusion of a significant
number of photons scattered into the observing beam.

[^1]: See [karllark/dust_attenuation](https://github.com/karllark/dust_attenuation).

Any published dust extinction model is welcome for inclusion in this package.

# References

0 comments on commit cb29df6

Please sign in to comment.