Metadata-Version: 2.1
Name: spectrum-overload
Version: 0.2.2
Summary: Spectrum class that overloads operators.
Home-page: https://github.com/jason-neal/spectrum_overload
Author: Jason Neal
Author-email: jason.neal@astro.up.pt
License: MIT Licence
Download-URL: https://github.com/jason-neal/spectrum_overload
Description: # spectrum_overload
        [![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/jason-neal)
        [![PyPI version](https://badge.fury.io/py/spectrum-overload.svg)](https://badge.fury.io/py/spectrum-overload)[![Updates](https://pyup.io/repos/github/jason-neal/spectrum_overload/shield.svg)](https://pyup.io/repos/github/jason-neal/spectrum_overload/)[![Python 3](https://pyup.io/repos/github/jason-neal/spectrum_overload/python-3-shield.svg)](https://pyup.io/repos/github/jason-neal/spectrum_overload/)
        
        [![Documentation Status](https://readthedocs.org/projects/spectrum-overload/badge/?version=latest)](http://spectrum-overload.readthedocs.io/en/latest/?badge=latest) [![Build Status](https://travis-ci.org/jason-neal/spectrum_overload.svg?branch=master)](https://travis-ci.org/jason-neal/spectrum_overload) [![Coverage Status](https://coveralls.io/repos/github/jason-neal/spectrum_overload/badge.svg?branch=master)](https://coveralls.io/github/jason-neal/spectrum_overload?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/3e9a2cf4ad914e0ebc24b6b2b83059db)](https://www.codacy.com/app/jason-neal/spectrum_overload?utm_source=github.com&utm_medium=referral&utm_content=jason-neal/spectrum_overload&utm_campaign=badger)[![Test Coverage](https://codeclimate.com/github/jason-neal/spectrum_overload/badges/coverage.svg)](https://codeclimate.com/github/jason-neal/spectrum_overload/coverage) [![Code Climate](https://codeclimate.com/github/jason-neal/spectrum_overload/badges/gpa.svg)](https://codeclimate.com/github/jason-neal/spectrum_overload)[![Issue Count](https://codeclimate.com/github/jason-neal/spectrum_overload/badges/issue_count.svg)](https://codeclimate.com/github/jason-neal/spectrum_overload)  
         
        
        ## Overview
        The purpose of this was project was to learn how to use and create Classes, and to create a Spectrum object to use within my Phd work.
        
        The main goals of this project are basically complete.
        
        - create a class to contain spectrum
        - automatic interpolation
        - overloaded operators
        especially
        - Spectral division (SpectrumA / SpectrumB )
        - Spectral subtraction (SpectrumA - SpectrumB)
        - Powers/exponents (Spectrum ** x)
        
        Further documentation can be found on [read the docs](https://spectrum-overload.readthedocs.io/en/latest/).
        
        ## Installation
        ### Pip
            
            pip install spectrum-overload
        
        ### git / manual 
        Currently to install and use Spectrum class for your own projects.
        
        clone the git repository where you want it then type:
        
            git clone https://github.com/jason-neal/spectrum_overload.git
            cd spectrum_overload
            python setup.py install
        
        or `python setup.py develop` if you want to make changes.
        
        
        ## Usage
        To use import the class using :
        
            from spectrum_overload import Spectrum
            ...
            my_spectrum = Spectrum.Spectrum(flux, xaxis)
        
        or :
        
            from spectrum_overload.Spectrum import Spectrum as spec
            ...
            my_spectrum = spec(flux, xaxis)
        
        or how ever else you would like to import it.
        
        A tutorial is provided [here](Notebooks/Tutorial.ipynb) to show an example of how to use this class. 
        
        
        ## Contributions
        Contributions are very welcome.
        
        I would really appreciate user feedback or suggested improvements if you have any.
        
        Feel free to submit issues or create pull requests.
        
        
        
        ## Other Spectrum Classes
        
        There are many other spectrum classes around but I didn't see any that overload the operators. (I could be blind).
        
        One of these may better suit your needs
        
        - https://github.com/crawfordsm/specreduce
        - https://github.com/crawfordsm/pyspectrograph/tree/master/PySpectrograph/Spectra
        - http://pyspeckit.bitbucket.org/html/sphinx/spectrum.html#pyspeckit.spectrum.classes.Spectrum
        - https://github.com/cokelaer/spectrum
        - https://github.com/astropy/specutils
        
        Wow A lot. I probably should not reinvent the wheel too much then...
        
        It turns out that astropy/specutils is very similar to what I have created but its direction is uncertain at the moment and they do not use overloaded operators and will not implement in the foreseeable future.
        
        ## TO DO
        Some tasks still to do:
        - Improve Documentation
        - Generate Calibration solution (outside spectrum class)?
        
Keywords: astronomy,spectra,spectroscopy,CRIRES
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Natural Language :: English
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
Provides-Extra: docs
