TAT-pulsar documentation
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!
Open your terminal or command prompt.
Type in the following command:
pip install tat-pulsar
Let pip handle the rest. You should see messages indicating that TAT-Pulsar was successfully installed.
Open your terminal or command prompt.
Navigate to the directory where you want to clone the GitHub repository using the ‘cd’ command:
cd /path/to/your/directory
Clone the TAT-Pulsar repository with the following command:
git clone https://github.com/tuoyl/TAT-pulsar.git
Once you follow these steps, you’ll find a new folder named ‘tat-pulsar’. Inside this folder, there’s a file called ‘setup.py’ - this little script is our ticket to installing the entire package.But before we dive into installation, here’s a pro tip: it’s a smart move to create a new conda environment first. Why? Well, it helps keep things clean and tidy, avoiding any clashes with your existing Python environment.
create a conda Environment
conda create -n tatpulsar-env python=3
conda activate tatpulsar-env
install the source code
python3 -m pip install -e .