Metadata-Version: 2.1
Name: your
Version: 0.5.1
Summary: A unified reader for sigproc filterbank and psrfits data
Home-page: https://github.com/thepetabyteproject/your
Author: Devansh Agarwal, Kshitij Aggarwal
Author-email: da0017@mix.wvu.edu, ka0064@mix.wvu.edu
License: UNKNOWN
Platform: UNKNOWN
Classifier: Natural Language :: English
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Topic :: Scientific/Engineering :: Astronomy
Description-Content-Type: text/markdown
Requires-Dist: matplotlib (>=3.2.1)
Requires-Dist: numpy (>=1.18.4)
Requires-Dist: h5py (>=2.10.0)
Requires-Dist: scikit-image (>=0.14.2)
Requires-Dist: scipy (>=1.3.0)
Requires-Dist: numba (>=0.48.0)
Requires-Dist: astropy (>=4.0)
Requires-Dist: tqdm (>=4.46.0)
Requires-Dist: pandas (>=1.0.3)

# your

[![Issues](https://img.shields.io/github/issues/devanshkv/your?style=flat-square)](https://github.com/devanshkv/your/issues)
[![Forks](https://img.shields.io/github/forks/devanshkv/your?style=flat-square)](https://github.com/devanshkv/your/network/members)
[![Stars](https://img.shields.io/github/stars/devanshkv/your?style=flat-square)](https://github.com/devanshkv/your/stargazers)
[![License](https://img.shields.io/github/license/devanshkv/your?style=flat-square)](https://github.com/devanshkv/your/blob/master/LICENSE)
[![HitCount](http://hits.dwyl.com/devanshkv/your.svg)](http://hits.dwyl.com/devanshkv/your)
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fdevanshkv%2Fyour%2Fbadge&style=flat-square)](https://github.com/devanshkv/your/actions)
[![codecov](https://codecov.io/gh/devanshkv/your/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/devanshkv/your)


`your` stands for Your Unified Reader. This library can read data in sigproc filterbanks, psrfits, and psrdada formats in a unified way and can go from one format to another.

| Format        | Read                     | Write               |
| ------------- |:-------------:           | -----:              |
| filterbank    | :white_check_mark:       | :white_check_mark:  |
| psrfits       | :white_check_mark:       | :white_check_mark:  |
| psrdada       | :x:                      | :white_check_mark:  |

The inspiration for the name comes from the introduction of every [Daily Dose of Internet](https://www.youtube.com/channel/UCdC0An4ZPNr_YiFiYoVbwaw) video.

# Installation
Here is how you can install `your`:

```bash
pip install your
``````


**Note**: If you want to use dada, then you need to install [psrdada-python](https://github.com/AA-ALERT/psrdada-python). 
[`your_heimdall.py`](https://thepetabyteproject.github.io/your/bin/your_heimdall/) requires [Heimdall](https://sourceforge.net/projects/heimdall-astro/) to be installed in addition to psrdada-python. 


# Documentation
Have a look at our [docs](https://thepetabyteproject.github.io/your/) for the documentation.

# Tutorials
Here are some [tutorial notebooks](https://github.com/devanshkv/your/tree/master/examples) to get you started.

# Code Contributions
We welcome all types of code contribution. Please have a look at our [guideline](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md).



