karllark / dust_attenuation

Astronomical Dust Attenuation
http://dust-attenuation.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
4 stars 8 forks source link
astronomy astrophysics astropy attenuation dust dust-attenuation

Astronomical dust attenuation

This package provides astronomical interstellar dust attenuation curves implemented using the astropy.modeling framework.

This package is potentially an affiliated package of AstroPy_.

To install::

pip install git+https://github.com/karllark/dust_attenuation.git

Build checks/status

.. image:: http://readthedocs.org/projects/dust-attenuation/badge/?version=latest :target: http://dust-attenuation.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. image:: https://github.com/karllark/dust_attenuation/workflows/Python%20Tests/badge.svg :target: https://github.com/karllark/dust_attenuation/actions/ :alt: Test Status

.. image:: https://codecov.io/gh/karllark/dust_attenuation/branch/master/graph/badge.svg :target: https://codecov.io/gh/karllark/dust_attenuation :alt: Test Coverage Status

.. image:: https://app.codacy.com/project/badge/Grade/0f272a569b954b2abac766a3900941ce :target: https://www.codacy.com/manual/kgordon/dust_attenuation?utm_source=github.com&utm_medium=referral&utm_content=karllark/dust_attenuation&utm_campaign=Badge_Grade :alt: Codacy Status

Packaging

.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat :target: http://www.astropy.org :alt: Powered by Astropy Badge

Documenation

Using readthedocs: http://dust-attenuation.readthedocs.io

In Development!

This code is currently in active development. Contributions welcome (see below).

Contributors

Karl Gordon, David Corre

All contributors <https://github.com/karllark/dust_attenuation/graphs/contributors>_

Contributing

Please open a new issue or new pull request for bugs, feedback, or new features you would like to see. If there is an issue you would like to work on, please leave a comment and we will be happy to assist. New contributions and contributors are very welcome!

New to github or open source projects? If you are unsure about where to start or haven't used github before, please feel free to contact @karllark. Want more information about how to make a contribution? Take a look at the astropy contributing and developer documentation.

Feedback and feature requests? Is there something missing you would like to see? Please open an issue or send an email to @karllark. dustattenuation follows the Astropy Code of Conduct and strives to provide a welcoming community to all of our users and contributors.

We love contributions! dust_attenuation is open source, built on open source, and we'd love to have you hang out in our community.

Impostor syndrome disclaimer: We want your help. No, really.

There may be a little voice inside your head that is telling you that you're not ready to be an open source contributor; that your skills aren't nearly good enough to contribute. What could you possibly offer a project like this one?

We assure you - the little voice in your head is wrong. If you can write code at all, you can contribute code to open source. Contributing to open source projects is a fantastic way to advance one's coding skills. Writing perfect code isn't the measure of a good developer (that would disqualify all of us!); it's trying to create something, making mistakes, and learning from those mistakes. That's how we all improve, and we are happy to help others learn.

Being an open source contributor doesn't just mean writing code, either. You can help out by writing documentation, tests, or even giving feedback about the project (and yes - that includes giving feedback about the contribution process). Some of these contributions may be the most valuable to the project as a whole, because you're coming to the project with fresh eyes, so you can see the errors and assumptions that seasoned contributors have glossed over.

This disclaimer was originally written by Adrienne Lowe <https://github.com/adriennefriend> for a PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>, and was adapted by dustattenuation based on its use in the README file for the MetPy project <https://github.com/Unidata/MetPy>.

License

This project is Copyright (c) Karl Gordon and licensed under the terms of the BSD 3-Clause license. This package is based upon the Astropy package template <https://github.com/astropy/package-template>_ which is licensed under the BSD 3-clause licence. See the licenses folder for more information.

.. _AstroPy: https://www.astropy.org/ .. _contributing: https://docs.astropy.org/en/stable/index.html#contributing .. _developer: https://docs.astropy.org/en/latest/index_dev.html .. _Astropy Code of Conduct: https://www.astropy.org/about.html#codeofconduct