Metadata-Version: 2.1
Name: cfod
Version: 2021.6.4
Summary: CHIME FRB Open Data
Home-page: https://chime-frb-open-data.github.io/
License: MIT
Author: Shiny Brar
Author-email: charanjotbrar@gmail.com
Requires-Python: >=3.7.1,<3.10
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: pandas
Requires-Dist: click (>=8.0.1,<9.0.0)
Requires-Dist: h5py (>=3.2.1,<4.0.0)
Requires-Dist: healpy (>=1.14.0,<2.0.0)
Requires-Dist: matplotlib (>=3.4.2,<4.0.0)
Requires-Dist: msgpack-python (>=0.5.6,<0.6.0)
Requires-Dist: numpy (>=1.20.3,<2.0.0)
Requires-Dist: pandas (>=1.2.4,<2.0.0); extra == "pandas"
Requires-Dist: scipy (>=1.6.3,<2.0.0)
Project-URL: Repository, https://github.com/chime-frb-open-data/chime-frb-open-data
Description-Content-Type: text/markdown

<h1 align="center">
  <br>
  <a href="https://chime-frb-open-data.github.io"><img src="https://github.com/chime-frb-open-data/chime-frb-open-data.github.io/blob/79d7c2d574a6c849125583395f5442333630222d/docs/static/chime-frb-logo.png" alt="" width="25%"></a>
  <br>
  Utililes for CHIME/FRB Open Data Releases.
  <br>
</h1>


## Installation
```
pip install --user cfod

# To install with pandas support,
pip install --user cfod[pandas]
```

## Documentation
Check out the user documentation, [here](https://chime-frb-open-data.github.io/)


## Developer
```
# cfod uses poetry for package management and virtualenv management
pip install poetry

git clone git@github.com:chime-frb-open-data/chime-frb-open-data.git
cd chime-frb-open-data

# Install git-commit hook
poetry run pre-commit install

# Make changes to the code and open a PR
```

## Removal
```
pip uninstall cfod
```


<p align="center">
  <a href="Some Love">
    <img src="https://forthebadge.com/images/badges/built-with-love.svg">
  </a>
</p>

