TAT-pulsar (Timing Analysis Toolkit for pulsar astrophysics)
Hey there! This is a Python toolbox made for folks interested in messing around with pulsar timing analysis, especially in high-energy scenarios. You know those pesky corrections needed for stuff like the barycentric correction and binary systems? Yeah, we’ve got functions for those. Plus, we’ve included some timing analysis tools and some examples to help you get started with your pulsar timing exploration. Enjoy!
Install the Package using pip
- Open your terminal or command prompt.
- Type in the following command:
pip install 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:
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
