Metadata-Version: 1.2
Name: pyymw16
Version: 2.0.0
Summary: Python/C++ version of YMW16 electron density model
Home-page: https://github.com/telegraphic/pyymw16
Author: D. Price
Author-email: dancpr@berkeley.edu
License: UNKNOWN
Download-URL: https://github.com/telegraphic/pyymw16/archive/2.0.0.tar.gz
Description: [![Build Status](https://travis-ci.org/telegraphic/pyymw16.svg?branch=master)](https://travis-ci.org/telegraphic/pyymw16)
        [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
        [![Coverage Status](https://codecov.io/gh/telegraphic/pyymw16/branch/master/graph/badge.svg)](https://codecov.io/gh/telegraphic/pyymw16)
        
        # PyYMW16
        _A Python / C++ Version of YMW16 electron-density model_
        
        This is a Python / C++ port of the Yao, Manchester and Wang (2017, [Astrophys. J., 835, 29](https://iopscience.iop.org/article/10.3847/1538-4357/835/1/29/meta);
        [arXiv:1610.09448](https://arxiv.org/abs/1610.09448)) YMW16 electron density model.
        The code uses [pybind11](https://pybind11.readthedocs.io/en/stable/intro.html)
        to create Python bindings to the (C++ ported) YMW16 code.
        
        ### Usage
        
        Some usage examples can be found in the [examples directory](https://github.com/telegraphic/pyymw16/tree/master/examples). 
        
        ```python
        import pyymw16
        
        # calculate DM at a given distance
        DM, tau_sc = pyymw16.dist_to_dm(204.0, -6.5, 200)
        
        # calculate distance for a given sky position and DM
        dist, tau_sc = pyymw16.dm_to_dist(123.4, 4.0, 200)
        
        # calculate N_e density at xyz galactocentric coordinates
        ne = pyynmw16.calculate_electron_density_xyz(1.0, 2.0, 3.0)
        
        # calculate N_e density at Galactic lat/long/distance coords
        ne = pyynmw16.calculate_electron_density_lbr(204.0, -6.5, 3000.0)
        
        ```
        
        The methods return astropy [Quantities](http://docs.astropy.org/en/stable/units/quantity.html#quantity), which have units attached, and can accept astropy [Angles](http://docs.astropy.org/en/stable/coordinates/angles.html#working-with-angles) and Quantities as arguments:
        
        ```python
        import pyymw16
        import astropy.units as u
        import astropy.coordinates as c
        DM = u.Quantity(10.0, unit='pc cm^-3')
        ra, dec = c.Angle(23.0, unit='hourangle'), c.Angle('-43:00:02', unit='degree')
        sky_coords = c.SkyCoord(ra, dec, frame='icrs')
        dist, tau_sc = pyymw16.dm_to_dist(sky_coords.galactic.l, sky_coords.galactic.b, DM)
        
        print(dist.to('lyr'))
        >> 3362.16343117 lyr
        print(tau_sc.to('ns'))
        >> 7.758686138 ns
        ```
        
        
        ### Installation
        
        Requires pybind11, astropy, and a newish C compiler with C++11 support (Ubuntu 16.04+ default gcc will work).
        
        You should be able to install with:
        
        ```
        pip install git+https://github.com/telegraphic/pyymw16
        ```
        
        Or, download this repository and install via
        
        ```
        python setup.py install
        ```
        
        To run unit tests, run `python setup.py test`. Note that these tests only check the Python bindings, not the underlying C source code.
        
        ## YMW16 C README
        
        YMW16 is a model for the distribution of free electrons in the Galaxy,
        the Magellanic Clouds and the inter-galactic medium, that can be used
        to estimate distances for real or simulated pulsars and fast radio
        bursts (FRBs) based on their position and dispersion measure.
        
        The Galactic model is based on 189 pulsars that have independently
        determined distances as well as dispersion measures, whereas simpler
        models are used for the electron density in the MC and the IGM. It is
        estimated that the 95% of predicted Galactic pulsar distances will
        have a relative error of less than a factor of 0.9. Pulse broadening
        due to scattering in the Galactic interstellar medium, the Magellanic
        Clouds, the intergalactic medium and FRB host galaxies is estimated.
        
        As well as the ymw16 dm-distance program, we also provide a program,
        ymw16_ne, which gives the electron density at any point in the Galaxy
        or Magellanic Clouds.
        
        A paper (Yao, Manchester and Wang, 2017, [Astrophys. J., 835, 29](https://iopscience.iop.org/article/10.3847/1538-4357/835/1/29/meta);
        [arXiv:1610.09448](https://arxiv.org/abs/1610.09448)) describes the model and compares its predictions
        with those of earlier Galactic electron density models. YMW16 is the
        first electron-density model to estimate extragalactic pulsar
        distances and FRB distances.
        
        To make a command-line executable version of the program, download and
        unpack the latest version of the program. Then run "make_ymw16" to
        create the executable. The environment variable YMW16_DIR may be set
        up to point at a directory containing ymw16par.txt and
        spiral.txt. Access to these files is needed at runtime.
        
        Websites allowing interactive access to the YMW16 distance model and
        download of the latest program version are available at
        http://www.xao.ac.cn/ymw16/,
        http://www.atnf.csiro.au/research/pulsar/ymw16/ and
        https://bitbucket.org/psrsoft/ymw16/.
        
        Please report any issues or bugs at
        https://bitbucket.org/psrsoft/ymw16/issues/new/ or directly to the
        authors. Please provide an example illustrating the problem.
        
        ### YMW16 C LICENSE
        
        ```
        Copyright (C) 2016, 2017  J. M. Yao, R. N. Manchester, N. Wang.
        
        YMW16 is free software: you can redistribute it and/or modify　it
        under the terms of the GNU General Public License as published by the
        Free Software Foundation, either version 3 of the License, or (at your
        option) any later version.
        
        YMW16 is distributed in the hope that it will be useful,　but WITHOUT
        ANY WARRANTY; without even the implied warranty of　MERCHANTABILITY or
        FITNESS FOR A PARTICULAR PURPOSE. See the　GNU General Public License,
        available at http://www.gnu.org/licenses/, for more details.
        
        Jumei Yao (yaojumei _@_ xao.ac.cn), Richard N Manchester
        (dick.manchester _@_ csiro.au), Na Wang (na.wang _@_ xao.ac.cn)
        ```
        
Platform: UNKNOWN
Requires-Python: >=2.7
