Metadata-Version: 1.1
Name: hasasia
Version: 1.0.0
Summary: A Python package to calculate gravitational-wave sensitivity curves for pulsar timing arrays.
Home-page: https://github.com/Hazboun6/hasasia
Author: Jeffrey S. Hazboun
Author-email: jeffrey.hazboun@gmail.com
License: MIT license
Description: ===========
        ``hasasia``
        ===========
        
        
        .. image:: https://img.shields.io/pypi/v/hasasia.svg
                :target: https://pypi.python.org/pypi/hasasia
        
        .. image:: https://img.shields.io/travis/Hazboun6/hasasia.svg
                :target: https://travis-ci.org/Hazboun6/hasasia
        
        .. image:: https://readthedocs.org/projects/hasasia/badge/?version=latest
                :target: https://hasasia.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        A Python package to calculate gravitational-wave sensitivity curves for pulsar timing arrays.
        
        .. image:: https://raw.githubusercontent.com/Hazboun6/hasasia/master/hasasia_calligraphy.jpg
                :align: center
        
        حساسية (hasasia) is Arabic for sensitivity_ . Image Credit: Reem Tasyakan
        
        .. _sensitivity: https://translate.google.com/#view=home&op=translate&sl=auto&tl=ar&text=sensitivity
        
        * Free software: MIT license
        * Documentation: https://hasasia.readthedocs.io.
        
        
        Features
        --------
        Calculates the following structures needed for signal analysis with pulsars:
        
        * Pulsar transmission functions
        * Inverse-noise-weighted transmission functions
        * Individual pulsar sensitivity curves.
        * Pulsar timing array sensitivity curves as characteristic strain, strain sensitivity or energy density.
        * Power-law integrated sensitivity curves.
        * Sensitivity sky maps for pulsar timing arrays
        
        Getting Started
        ---------------
        
        `hasasia` is on the Python Package Inventory, so the easiest way to get started
        is by using `pip` to install::
        
          pip install hasasia
        
        The pulsar and spectrum objects are used to build sensitivity curves for full
        PTAs. The Spectrum object has all of the information needed for the pulsar.
        
        .. code-block:: python
        
          import hasasia.senstivity as hsen
        
          toas = np.arange(54378,59765,22) #Choose a range of times-of-arrival
          toaerrs = 1e-7*np.ones_like(toas) #Set all errors to 100 ns
          psr = hsen.Pulsar(toas=toas,toaerrs=toaerrs)
          spec = hsen.Spectrum(psr)
        
        
        Publication
        -----------
        This work is featured in a publication_, currently released on the arXiv. If you
        would like to reference this work please use the following attribution:
        
        .. _publication: https://arxiv.org/pdf/1907.04341.pdf
        
        .. code-block:: tex
        
          @article{Hazboun:2019vhv,
                   author         = "Hazboun, Jeffrey S. and Romano, Joseph D. and Smith, Tristan L.",
                   title          = "{Realistic sensitivity curves for pulsar timing arrays}",
                   year           = "2019",
                   eprint         = "1907.04341",
                   archivePrefix  = "arXiv",
                   primaryClass   = "gr-qc",
                   SLACcitation   = "%%CITATION = ARXIV:1907.04341;%%"
                   }
        
        Credits
        -------
        Development Team: Jeffrey S. Hazboun, Joseph D. Romano  and Tristan L. Smith
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        1.0.0 (2019-09-20)
        The Official Release. 
        0.1.6 (2019-08-30)
        0.1.6 (2019-08-29)
        0.1.5 (2019-08-13)
        0.1.4 (2019-08-13)
        0.1.3 (2019-08-13)
        0.1.2 (2019-06-23)
        0.1.1 (2019-06-23)
        0.1.0 (2019-06-23)*
        ------------------
        
        * First release on PyPI.
        
Keywords: hasasia
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
