Your
Your: Your Unified Reader - Published in JOSS (2020)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
6 of 19 committers (31.6%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Scientific Fields
Repository
Your Unified Reader
Basic Info
- Host: GitHub
- Owner: thepetabyteproject
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Homepage: https://thepetabyteproject.github.io/your/
- Size: 95.4 MB
Statistics
- Stars: 38
- Watchers: 4
- Forks: 26
- Open Issues: 2
- Releases: 17
Topics
Metadata Files
README.md
your
your stands for Your Unified Reader. This library can read data in Sigproc Filterbank,
PSRFITS,
and PSRDADA formats in a unified way and can convert from one format to another.
your implements a user-friendly interface to read and write in the data format of choice. It also generates unified
metadata corresponding to the input data file for a quick understanding of observation parameters and provides
utilities to perform common data analysis operations. your can be used at the data ingestion step of any transient
search pipeline and can provide data and observation parameters in a format-independent manner. Generic tools can thus
be used to perform the search and further data analysis. It also enables online processing like RFI flagging,
decimation, subband search, etc.; functions for some of these are already available in your.
your will not only be useful to experienced researchers but also new undergraduate and graduate students who otherwise
have to face a significant bottleneck to understand various data formats and develop custom tools to access the data
before any analysis can be done on it.
The inspiration for the name comes from the introduction of every Daily Dose of Internet video.
Installation
You can install your directly using pip
bash
pip install your
Or if you want to try out the lastest stuff,
bash
pip install git+https://github.com/thepetabyteproject/your.git
or you can do:
bash
git clone https://github.com/thepetabyteproject/your.git
cd your
pip install -r requirements.txt
python setup.py install
Note:
To use the psrdada format, you would need to install psrdada-python. your_heimdall.py requires Heimdall and psrdada-python.
To run the tests you would need to install pytest.
Documentation
Have a look at our docs for the documentation.
Tutorials
Here are some tutorial notebooks to get you started.
Note:
To run the tutorial notebooks you would need to install jupyter.
Citation
If you use Your, please cite our JOSS Paper:
bash
@article{Aggarwal2020,
doi = {10.21105/joss.02750},
url = {https://doi.org/10.21105/joss.02750},
year = {2020},
publisher = {The Open Journal},
volume = {5},
number = {55},
pages = {2750},
author = {Kshitij Aggarwal and Devansh Agarwal and Joseph W. Kania and William Fiore and Reshma Anna Thomas and Scott M. Ransom and Paul B. Demorest and Robert S. Wharton and Sarah Burke-Spolaor and Duncan R. Lorimer and Maura A. Mclaughlin and Nathaniel Garver-Daniels},
title = {Your: Your Unified Reader},
journal = {Journal of Open Source Software}
}
Contributions
Code Contributions
We welcome all types of code contribution. Please have a look at our guideline and code of conduct.
Contributors
Owner
- Name: The Petabyte Project
- Login: thepetabyteproject
- Kind: organization
- Location: United States of America
- Website: thepetabyteproject.github.io
- Repositories: 8
- Profile: https://github.com/thepetabyteproject
JOSS Publication
Your: Your Unified Reader
Authors
West Virginia University, Department of Physics and Astronomy, P. O. Box 6315, Morgantown 26506, WV, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown 26506, WV, USA
West Virginia University, Department of Physics and Astronomy, P. O. Box 6315, Morgantown 26506, WV, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown 26506, WV, USA
West Virginia University, Department of Physics and Astronomy, P. O. Box 6315, Morgantown 26506, WV, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown 26506, WV, USA
West Virginia University, Department of Physics and Astronomy, P. O. Box 6315, Morgantown 26506, WV, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown 26506, WV, USA
West Virginia University, Department of Physics and Astronomy, P. O. Box 6315, Morgantown 26506, WV, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown 26506, WV, USA
National Radio Astronomy Observatory, Charlottesville, VA 22903, USA
National Radio Astronomy Observatory, Socorro, NM, 87801, USA
Max-Planck-Institut für Radioastronomie, Auf dem Hügel 69, D-53121 Bonn, Germany
West Virginia University, Department of Physics and Astronomy, P. O. Box 6315, Morgantown 26506, WV, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown 26506, WV, USA
West Virginia University, Department of Physics and Astronomy, P. O. Box 6315, Morgantown 26506, WV, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown 26506, WV, USA
West Virginia University, Department of Physics and Astronomy, P. O. Box 6315, Morgantown 26506, WV, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown 26506, WV, USA
West Virginia University, Department of Physics and Astronomy, P. O. Box 6315, Morgantown 26506, WV, USA, Center for Gravitational Waves and Cosmology, West Virginia University, Chestnut Ridge Research Building, Morgantown 26506, WV, USA
Editor
Dan Foreman-Mackey
Tags
astronomy fast transients neutron stars fast radio burstsGitHub Events
Total
- Create event: 6
- Release event: 1
- Issues event: 5
- Watch event: 2
- Delete event: 3
- Issue comment event: 22
- Push event: 12
- Pull request review event: 7
- Pull request event: 16
- Fork event: 1
Last Year
- Create event: 6
- Release event: 1
- Issues event: 5
- Watch event: 2
- Delete event: 3
- Issue comment event: 22
- Push event: 12
- Pull request review event: 7
- Pull request event: 16
- Fork event: 1
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Devansh Agarwal | d****v@g****m | 301 |
| Kshitij Aggarwal | k****4@m****u | 243 |
| josephwkania | 6****a | 45 |
| jkania7 | j****a@a****u | 14 |
| renovate[bot] | 2****] | 8 |
| ReshmaAnnaThomas | r****2@m****u | 5 |
| Dan Foreman-Mackey | f****y@g****m | 4 |
| Mohammed Chamma | h****d@g****m | 4 |
| Reshma Thomas | r****2@g****m | 3 |
| MSnelders | m****4@g****m | 3 |
| Sujay Mate | s****e@g****m | 3 |
| wcfiore | w****8@g****m | 3 |
| google-labs-jules[bot] | 1****] | 2 |
| Evan Lewis | e****3@m****u | 1 |
| Leon Oostrum | l****m@g****m | 1 |
| Nate Garver-Daniels | n****s@m****u | 1 |
| Sarah Burke Spolaor | s****r@g****m | 1 |
| Reshma Thomas | r****2@b****u | 1 |
| Timothy Olszanski | 5****s | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 65
- Total pull requests: 66
- Average time to close issues: about 1 month
- Average time to close pull requests: 7 days
- Total issue authors: 23
- Total pull request authors: 17
- Average comments per issue: 2.4
- Average comments per pull request: 1.24
- Merged pull requests: 55
- Bot issues: 2
- Bot pull requests: 14
Past Year
- Issues: 4
- Pull requests: 15
- Average time to close issues: about 20 hours
- Average time to close pull requests: 25 days
- Issue authors: 4
- Pull request authors: 3
- Average comments per issue: 1.0
- Average comments per pull request: 1.27
- Merged pull requests: 9
- Bot issues: 0
- Bot pull requests: 5
Top Authors
Issue Authors
- KshitijAggarwal (17)
- devanshkv (13)
- aweaver1fandm (4)
- pravirkr (4)
- ftorres-ucf (2)
- mabaisen (2)
- MSnelders (2)
- mef51 (2)
- sahilatri126 (2)
- ReshmaAnnaThomas (2)
- aaronpearlman (2)
- irfnt (1)
- dependabot-preview[bot] (1)
- renovate[bot] (1)
- Shinnnosuke2 (1)
Pull Request Authors
- josephwkania (19)
- renovate[bot] (14)
- devanshkv (8)
- KshitijAggarwal (6)
- wcfiore (3)
- jkania7 (2)
- ReshmaAnnaThomas (2)
- nategarver-daniels (2)
- dfm (2)
- sujaymate (2)
- eflewis312 (2)
- MSnelders (1)
- tolszans (1)
- dependabot[bot] (1)
- loostrum (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 475 last-month
-
Total dependent packages: 2
(may contain duplicates) -
Total dependent repositories: 70
(may contain duplicates) - Total versions: 12
- Total maintainers: 4
pypi.org: your
A unified reader for sigproc filterbank and psrfits data
- Homepage: https://github.com/thepetabyteproject/your
- Documentation: https://your.readthedocs.io/
- License: GNU General Public License v3 (GPLv3)
-
Latest release: 0.6.7
published almost 4 years ago
Rankings
spack.io: py-your
Python library to read and process pulsar data in several different formats
- Homepage: https://github.com/thepetabyteproject/your
- License: []
-
Latest release: 0.6.7
published over 1 year ago
Rankings
Maintainers (1)
Dependencies
- argmark >=0.3
- keras-autodoc >=0.7.0
- mike >=1.1.2
- mkdocs >=1.2.3
- mkdocs-jupyter >=0.18.2
- mkdocs-material >=6.2.7
- astropy >=4.0
- h5py >=2.10.0
- matplotlib >=3.2.1
- numba >=0.48.0
- numpy >=1.18.4
- pandas >=1.0.3
- rich >=8.0
- scikit-image >=0.14.2
- scipy >=1.3.0
- actions/checkout v3 composite
- actions/setup-python v4 composite
- codecov/codecov-action v3 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite