tat-pulsar 0.1.0

timing library for high energy Pulsar observation

TAT-pulsar (Timing Analysis Toolkit for pulsar astrophysics)

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:

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.

conda create -n pulsar-timing python=3

after downloading the dependancies, execute

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!)
  • 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
    • tatpulsar.pulse.fold
    • tatpulsar.pulse.search
• Documentation (real data example, tutorial)
• barycentric correction module
  • add console script for Event FITS file barycor
• binary analysis (search, binary correction)
• profile simulator