A long-lived repository for NANOGrav Pulsar Timing analysis work.
Project description
PINT Pal
A repository for standardizing timing analysis and data combination work with a Jupyter notebook framework and corresponding tools.
pint_pal
includes tools and notebook templates to facilitate transparency and reproducibility in timing pulsars using PINT. Configuration (.yaml
) files contain relatively compact metadata to capture decisions made during the timing process so that such information can naturally be version controlled. Configuration files can be "plugged into" standardized notebook templates to asses and update results.
More information about available tools and use cases coming soon!
Getting started
PINT is necessary for core functionality of pint_pal
, but the following packages are also required to do detailed outlier inspection and run noise analyses:
There are instructions for installing these packages and setting up your environment here: https://github.com/ipta/pulsar-env. Please note that installing mamba
must be done from a clean (base) conda
environment; you can make and activate a fresh environment with, e.g.:
$ conda create --name installer && conda activate installer
Installation
pint_pal
is now available on PyPI, so users who do not wish to develop code can grab the latest tagged version with:
$ pip install pint-pal
You may also access the latest development (not tagged) version of the repository by cloning it from GitHub, then installing:
$ git clone https://github.com/nanograv/pint_pal.git
$ cd pint_pal
$ pip install .
To further develop pint_pal
code, fork this repository, clone your fork, then:
$ cd pint_pal
$ pip install -e .
$ git remote add upstream https://github.com/nanograv/pint_pal
Before making changes, we highly recommend using pulsar-env
(see above) to set up a consistent environment. Submit changes for review by opening a PR from your fork.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pint_pal-0.2.2.tar.gz
.
File metadata
- Download URL: pint_pal-0.2.2.tar.gz
- Upload date:
- Size: 119.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8e8d686d49d32544359b14410897a7fd9a00433890ba8ac357dbc47ac1fda81 |
|
MD5 | 03b0777f1d343d4dda5d10815bb565a0 |
|
BLAKE2b-256 | 50a35564baf5c5d548ef1e8c099c83aa102834439702be223ddc583a8376147e |
File details
Details for the file pint_pal-0.2.2-py3-none-any.whl
.
File metadata
- Download URL: pint_pal-0.2.2-py3-none-any.whl
- Upload date:
- Size: 122.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5db27b84e2d26c9f73494c6da6f2d2957f4e5849e948162d72c9c11287c77ead |
|
MD5 | ff7609a236377e78ba4b1e982b4298de |
|
BLAKE2b-256 | 032169fec999335c0257b2ff6e3775084cf0ed5175f4581fe0610b4fa5830bf7 |