A python package for the intersection of pulsar accelerations and Galactic structure
Project description
PEEBEE
Copyright Tom Donlon, 2024 UAH
github user: thomasdonlon
Requires Python v.>3.6.0
A python package for the intersection between pulsar timing, accelerations, and Galactic structure. Currently, this package mainly includes convenience functions for various things I have needed to do in pulsar acceleration research. This package will also form the foundation for the pulsars.uah.edu backend.
CONTENTS
A non-exhaustive list of contents of the package is given below:
- Ability to compute accelerations (including line-of-sight accelerations) for user-defined potentials (including support for gala and galpy potentials)
- Convenience functions for computing Pdots, including the Shklovskii effect, Relativistic orbital decay, Galactic accelerations, etc.
INSTALLATION
NOTICE: Will get put on Pypi soon. Until then, only manual installs are supported.
THE BELOW IS CURRENTLY NOT ACCURATE (BUT NOT DELETED SO THAT IT IS EASIER FOR ME TO NOT HAVE TO RE-TYPE IT LATER)
FOR USERS:
- Open your terminal, and run
python3 -m pip install peebee
FOR DEVELOPERS:
-
Clone the peebee github repository
-
Make the desired changes in the source code
-
Navigate to the directory where you cloned the repo, and then run
python3 setup.py develop --user
(note, you will probably need to uninstall any previous versions of peebee you had on your machine before running this)
- To test your changes, insert import statements for the subpackages that you want to use in your .py files as you normally would:
import peebee.{peebee subpackage}
...
-
Once you are done making changes to the source code, put in a pull request to master
-
Navigate to the directory where you cloned the repo, and then run
python3 setup.py develop --uninstall
pip3 install peebee
Your changes will not be available in the main peebee build until a new release comes out.
TODO
MAJOR:
- Finish initial build!
MINOR:
- Agama potentials?
- Make a decorator so that model.accel() and model.alos() support both array-like and non-array-like inputs
ISSUES
- No known issues
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.