| Name | peebee JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | https://github.com/thomasdonlon/peebee |
| Summary | A python package for the intersection of pulsar accelerations and Galactic structure |
| upload_time | 2024-09-06 16:37:00 |
| maintainer | None |
| docs_url | None |
| author | Tom Donlon |
| requires_python | >=3.6.0 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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
========================================
FOR USERS:
1. Open your terminal, and run
> python3 -m pip install peebee
FOR DEVELOPERS:
1. Clone the peebee github repository
2. Make the desired changes in the source code
3. 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)
4. 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}
> ...
5. Once you are done making changes to the source code, put in a pull request to master
6. 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:
- Add support for astropy units
MINOR:
- Agama potentials?
ISSUES
========================================
- Currently, the most up-to-date versions of astropy (v6.1.0) and gala (v1.8.1) result in an error being produced when computing accelerations using Gala potentials. This can be resolved by downgrading astropy to v5.3.0.
Raw data
{
"_id": null,
"home_page": "https://github.com/thomasdonlon/peebee",
"name": "peebee",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6.0",
"maintainer_email": null,
"keywords": null,
"author": "Tom Donlon",
"author_email": "thomas.donlon@uah.edu",
"download_url": "https://files.pythonhosted.org/packages/85/ea/af195170b9cdf761496a73c5236b128edd06b147df550e871b88ce3319f8/peebee-1.2.0.tar.gz",
"platform": null,
"description": "PEEBEE\n========================================\n\nCopyright Tom Donlon, 2024 UAH\n\ngithub user: thomasdonlon\n\nRequires Python v.>3.6.0\n\n-----------------------------------------\n\nA python package for the intersection between pulsar timing, accelerations, and Galactic structure.\nCurrently, this package mainly includes convenience functions for various things I have needed to do \nin pulsar acceleration research. This package will also form the foundation for the pulsars.uah.edu backend. \n\nCONTENTS\n========================================\n\nA non-exhaustive list of contents of the package is given below:\n\n - Ability to compute accelerations (including line-of-sight accelerations) for user-defined potentials \n (including support for gala and galpy potentials)\n - Convenience functions for computing Pdots, including the Shklovskii effect, Relativistic orbital decay, Galactic accelerations, etc. \n\nINSTALLATION\n========================================\n\nFOR USERS:\n\n1. Open your terminal, and run\n\n> python3 -m pip install peebee\n\nFOR DEVELOPERS:\n\n1. Clone the peebee github repository\n\n2. Make the desired changes in the source code\n\n3. Navigate to the directory where you cloned the repo, and then run\n\n> python3 setup.py develop --user\n\n(note, you will probably need to uninstall any previous versions of peebee you had on your machine before running this)\n\n4. To test your changes, insert import statements for the subpackages that you want to use in your .py files as you normally would:\n\n> import peebee.{peebee subpackage}\n\n> ...\n\n5. Once you are done making changes to the source code, put in a pull request to master\n\n6. Navigate to the directory where you cloned the repo, and then run\n\n> python3 setup.py develop --uninstall\n\n> pip3 install peebee\n\nYour changes will not be available in the main peebee build until a new release comes out.\n\nTODO\n========================================\n\nMAJOR:\n - Add support for astropy units\n\nMINOR:\n - Agama potentials?\n\nISSUES\n========================================\n\n- Currently, the most up-to-date versions of astropy (v6.1.0) and gala (v1.8.1) result in an error being produced when computing accelerations using Gala potentials. This can be resolved by downgrading astropy to v5.3.0. \n",
"bugtrack_url": null,
"license": null,
"summary": "A python package for the intersection of pulsar accelerations and Galactic structure",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/thomasdonlon/peebee"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a1c234e81477d561acccbaa3f19efe4ecd80d188d055a3de8fb3820ca822589",
"md5": "9ec8af95b78e7cc4dad617abdfdbc802",
"sha256": "9effa763dfcc2bea1b5660c9b2694c8df2bc95d136980ec93ed7d32aa48c3f16"
},
"downloads": -1,
"filename": "peebee-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ec8af95b78e7cc4dad617abdfdbc802",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.0",
"size": 59667,
"upload_time": "2024-09-06T16:36:58",
"upload_time_iso_8601": "2024-09-06T16:36:58.440621Z",
"url": "https://files.pythonhosted.org/packages/7a/1c/234e81477d561acccbaa3f19efe4ecd80d188d055a3de8fb3820ca822589/peebee-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85eaaf195170b9cdf761496a73c5236b128edd06b147df550e871b88ce3319f8",
"md5": "f69a426111403af79f1df78248b96348",
"sha256": "e914a733eea1e81de43573d93baae28680c10d45803d78bf890bb0aff7747c41"
},
"downloads": -1,
"filename": "peebee-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "f69a426111403af79f1df78248b96348",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.0",
"size": 58690,
"upload_time": "2024-09-06T16:37:00",
"upload_time_iso_8601": "2024-09-06T16:37:00.520386Z",
"url": "https://files.pythonhosted.org/packages/85/ea/af195170b9cdf761496a73c5236b128edd06b147df550e871b88ce3319f8/peebee-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-06 16:37:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thomasdonlon",
"github_project": "peebee",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "peebee"
}
