Metadata-Version: 2.1
Name: unred
Version: 0.1.0
Summary: Determine the interstellar extinction for observed stars.
Home-page: https://github.com/pbrus/unredden-stars
Author: Przemysław Bruś
License: UNKNOWN
Description: # Unredden-stars
        [![Build Status](https://travis-ci.org/pbrus/unredden-stars.svg?branch=master)](https://travis-ci.org/pbrus/unredden-stars) [![Code](https://img.shields.io/badge/code-Python-blue.svg "Python")](https://www.python.org/) [![License](https://img.shields.io/badge/license-MIT-yellow.svg "MIT license")](https://github.com/pbrus/unredden-stars/blob/master/LICENSE)
        
        This package allows to determine the interstellar extinction for stars lying on the color-color plane. Using:
        1. theoretical stars sequence
        2. reddening line slope
        3. positions of stars
        
        package functions calculate which part of the sequence the reddened stars come from. This allows to determine the color excess and hence the extinction of each star.
        
        ![unredden-stars](http://www.astro.uni.wroc.pl/ludzie/brus/img/github/unred-stars.gif)
        
        ## Installation
        
        The software was written in *Python 3*. To install it, please type from the command line:
        ```bash
        $ sudo pip3 install unred
        ```
        or alternatively:
        ```bash
        $ git clone https://github.com/pbrus/unredden-stars
        $ cd unredden-stars
        $ sudo python3 setup.py install
        ```
        Additionally the software uses the following modules:
        
         * *numpy*
         * *scipy*
        
        They can be easily installed too. Please run:
        ```bash
        $ sudo pip3 install -r requirements.txt
        ```
        
        ## Usage
        
        It's recommended to use the `unred_stars.py` script which is a wrapper of all functions from the package. At the beginning call the script from the terminal window with the `-h` option:
        ```bash
        $ python3 unred_stars.py -h
        ```
        This will give you a description of available options. If you need to see the program in action immediately, you can use files from the `example_data/` directory:
        ```bash
        $ python3 unred_stars.py example_data/stars.dat example_data/ub_bv_dwarfs.dat 0.72 3.1
        ```
        Moreover, you can filter the output (by extinction value for each star) using `--min` or `--max` option:
        ```bash
        $ python3 unred_stars.py example_data/stars.dat example_data/ub_bv_dwarfs.dat 0.72 3.1 --min
        ```
        
        I encourage to visit my website to see more detailed description of this program. The current link can be found on my [GitHub profile](https://github.com/pbrus).
        
        ## License
        
        **Unredden-stars** is licensed under the [MIT license](http://opensource.org/licenses/MIT).
        
Keywords: reddening,extinction,stars
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
