Metadata-Version: 2.1
Name: tat-pulsar
Version: 0.3.1
Summary: timing library for high energy Pulsar observation
Home-page: https://github.com/tuoyl/tat-pulsar
Author: Youli Tuo
Author-email: tuoyl@ihep.ac.cn
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.7.10
Description-Content-Type: text/markdown
License-File: LICENSE


# TAT-pulsar (Timing Analysis Toolkit for pulsar astrophysics)
[![DOI:<your number>](https://zenodo.org/badge/DOI/10.5281/zenodo.6784362.svg)](<https://zenodo.org/record/6784362#.Yr5jiC8RqrM>)
[![Upload Python Package](https://github.com/tuoyl/tat-pulsar/actions/workflows/python-publish.yml/badge.svg)](https://github.com/tuoyl/tat-pulsar/actions/workflows/python-publish.yml)
[![codecov](https://codecov.io/github/tuoyl/tat-pulsar/branch/master/graph/badge.svg?token=LShslbL6pg)](https://codecov.io/github/tuoyl/tat-pulsar)

## Install the Package using conda

## Download the repository

Download the whole repository to your local directory using `git clone` or `git fetch`.

For example, In you local path execute:

```plaintext
git clone https://github.com/tuoyl/tat-pulsar.git
```

And you will get the folder `tat-pulsar`, in the folder you will see a file named `setup.py`. We will install the whole package based on this script.

## Create a conda environment

The most elegant thing to do before installing is to create a new conda environment to avoid conflicts with your existing python environment.

```plaintext
conda create -n pulsar-timing python=3
```

after downloading the dependancies, execute

```plaintext
conda activate pulsar-timing
```

to enter the pulsar-timing environment of conda, you will see `(pulsar-timing)` before the shell prompt.

## Install the repository

Now you are all set to install the repository. In the directory where the setup.py located, execute:

```
python3 -m pip install -e .
```

## Uninstall the repository

if you want to uninstall the package for generating the product.

```
python3 -m pip uninstall tat-pulsar
```

---
## Todo list
- [ ] optimize the structure of the package (!important!)
  - [x] root directory contains `data`, `utils`, `pulse`(for searching, folding and related timing analysis)
  - construct object for 
    - [ ] `Profile`
    - [ ] `TOA` defined in data directory
  - reconstruct and optimize the output results of
    - [x] `tatpulsar.pulse.fold` 
    - [ ] `tatpulsar.pulse.search`
- [ ] Documentation (real data example, tutorial)
- [x] barycentric correction module
    - [ ] add console script for Event FITS file barycor
- [ ] binary analysis (search, binary correction)
- [ ] profile simulator
