<p align="center">
<img width="260" src="https://raw.githubusercontent.com/maxmahlke/phunk/main/docs/gfx/logo_phunk.svg">
</p>
<p align="center">
<a href="https://github.com/maxmahlke/phunk#features"> Features </a> - <a href="https://github.com/maxmahlke/phunk#install"> Install </a> - <a href="https://github.com/maxmahlke/phunk#documentation"> Documentation </a>
</p>
<div align="center">
<a href="https://img.shields.io/pypi/pyversions/space-phunk">
<img src="https://img.shields.io/pypi/pyversions/space-phunk"/>
</a>
<a href="https://img.shields.io/pypi/v/space-phunk">
<img src="https://img.shields.io/pypi/v/space-phunk"/>
</a>
<a href="https://readthedocs.org/projects/phunk/badge/?version=latest">
<img src="https://readthedocs.org/projects/phunk/badge/?version=latest"/>
</a>
</div>
## Features
Observe the phase curve of an asteroid, ...
``` python
>>> from phunk import PhaseCurve
>>> # Observations of (20) Massalia from Gehrels 1956
>>> phase = [0.57, 1.09, 3.20, 10.99, 14.69, 20.42] # in degrees
>>> mag = [6.555, 6.646, 6.793, 7.130, 7.210, 7.414]
>>> epoch = [35193, 35194, 35198, 35214, 35223, 35242] # in MJD
>>> pc = PhaseCurve(phase=phase, mag=mag, epoch=epoch, target='massalia')
```
..., fit it in one of multiple photometric models, ....
``` python
>>> pc.fit(["HG", "HG12", "HG12S", "HG1G2", "sHG1G2", "LinExp"])
```
..., and plot / process the results.
``` python
>>> pc.HG1G2.H
>>> pc.HG12.H
>>> pc.plot()
```
## Install
Install from PyPi using `pip`:
$ pip install space-phunk
The minimum required `python` version is 3.8.
## Documentation
Check out the documentation at [phunk.readthedocs.io](https://phunk.readthedocs.io/en/latest/).
## Acknowledgements
This package uses photometric model implementations provided by [sbpy](https://sbpy.readthedocs.io/en/stable) and [fink](https://fink-portal.org/).
Raw data
{
"_id": null,
"home_page": "https://phunk.readthedocs.io/en/latest/",
"name": "space-phunk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Max Mahlke",
"author_email": "max.mahlke@oca.eu",
"download_url": "https://files.pythonhosted.org/packages/52/e0/23f49ae52178ac43e572f9b7bde2312e6c299df21be31cadd4886ee6b8d3/space_phunk-0.1.2.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img width=\"260\" src=\"https://raw.githubusercontent.com/maxmahlke/phunk/main/docs/gfx/logo_phunk.svg\">\n</p>\n\n<p align=\"center\">\n <a href=\"https://github.com/maxmahlke/phunk#features\"> Features </a> - <a href=\"https://github.com/maxmahlke/phunk#install\"> Install </a> - <a href=\"https://github.com/maxmahlke/phunk#documentation\"> Documentation </a>\n</p>\n\n<div align=\"center\">\n <a href=\"https://img.shields.io/pypi/pyversions/space-phunk\">\n <img src=\"https://img.shields.io/pypi/pyversions/space-phunk\"/>\n </a>\n <a href=\"https://img.shields.io/pypi/v/space-phunk\">\n <img src=\"https://img.shields.io/pypi/v/space-phunk\"/>\n </a>\n <a href=\"https://readthedocs.org/projects/phunk/badge/?version=latest\">\n <img src=\"https://readthedocs.org/projects/phunk/badge/?version=latest\"/>\n </a>\n</div>\n\n\n## Features\n\nObserve the phase curve of an asteroid, ...\n\n``` python\n>>> from phunk import PhaseCurve\n>>> # Observations of (20) Massalia from Gehrels 1956\n>>> phase = [0.57, 1.09, 3.20, 10.99, 14.69, 20.42] # in degrees\n>>> mag = [6.555, 6.646, 6.793, 7.130, 7.210, 7.414]\n>>> epoch = [35193, 35194, 35198, 35214, 35223, 35242] # in MJD\n>>> pc = PhaseCurve(phase=phase, mag=mag, epoch=epoch, target='massalia')\n```\n\n..., fit it in one of multiple photometric models, ....\n\n``` python\n>>> pc.fit([\"HG\", \"HG12\", \"HG12S\", \"HG1G2\", \"sHG1G2\", \"LinExp\"])\n```\n\n..., and plot / process the results.\n\n``` python\n>>> pc.HG1G2.H\n>>> pc.HG12.H\n>>> pc.plot()\n```\n\n\n\n## Install\n\nInstall from PyPi using `pip`:\n\n $ pip install space-phunk\n\nThe minimum required `python` version is 3.8.\n\n\n## Documentation\n\nCheck out the documentation at [phunk.readthedocs.io](https://phunk.readthedocs.io/en/latest/).\n\n## Acknowledgements\n\nThis package uses photometric model implementations provided by [sbpy](https://sbpy.readthedocs.io/en/stable) and [fink](https://fink-portal.org/).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Fit photometric phase curves of asteroids.",
"version": "0.1.2",
"project_urls": {
"Documentation": "https://phunk.readthedocs.io/en/latest/",
"Homepage": "https://phunk.readthedocs.io/en/latest/",
"Repository": "https://github.com/maxmahlke/phunk.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5cd169d578abe340467692a0247bc0d969882a2c75802facd5c6411b1f9d0509",
"md5": "93684112e4e59ce909315e1c60597346",
"sha256": "4578ad06d2e960e497667a76bcd0b04ed31b5ef5d59c0215fd7865971664c9f2"
},
"downloads": -1,
"filename": "space_phunk-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93684112e4e59ce909315e1c60597346",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11219,
"upload_time": "2024-09-28T20:02:22",
"upload_time_iso_8601": "2024-09-28T20:02:22.694801Z",
"url": "https://files.pythonhosted.org/packages/5c/d1/69d578abe340467692a0247bc0d969882a2c75802facd5c6411b1f9d0509/space_phunk-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "52e023f49ae52178ac43e572f9b7bde2312e6c299df21be31cadd4886ee6b8d3",
"md5": "95387ea72ee23ec57ca4c7ac3cdfa488",
"sha256": "49c16b899c23aed4654722460459d2338cb00153e5b0693d337c221b252d89ee"
},
"downloads": -1,
"filename": "space_phunk-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "95387ea72ee23ec57ca4c7ac3cdfa488",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10574,
"upload_time": "2024-09-28T20:02:24",
"upload_time_iso_8601": "2024-09-28T20:02:24.240695Z",
"url": "https://files.pythonhosted.org/packages/52/e0/23f49ae52178ac43e572f9b7bde2312e6c299df21be31cadd4886ee6b8d3/space_phunk-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-28 20:02:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxmahlke",
"github_project": "phunk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "space-phunk"
}
JSON
