| Name | panoptes-data JSON |
| Version |
0.2.3
JSON |
| download |
| home_page | None |
| Summary | Tools for working with PANOPTES data. |
| upload_time | 2025-10-20 22:23:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | The MIT License (MIT)
Copyright (c) 2022 Wilfred Tyler Gee
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
astronomy
data
panoptes
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
[](https://panoptes-data.readthedocs.io/en/latest/?badge=latest)
# PANOPTES Data tools
Tools for searching and downloading PANOPTES data.
## Install
Install from pip:
```bash
pip install panoptes-data
```
## Examples
See the example Jupyter Notebooks in the `notebooks/` directory.
### Finding observations
```py
from panoptes.data.search import search_observations
from panoptes.data.observations import ObservationInfo
# Find some observations
results = search_observations(by_name='M42')
# Use last result entry to create ObservationInfo object.
obs_info = ObservationInfo(meta=results.iloc[0])
print(obs_info.meta)
# Create an ObservationInfo object directly from a sequence_id.
obs_info = ObservationInfo('PAN001_14d3bd_20180113T052325')
# But then there is no metadata:
print(obs_info.meta)
```
```text
Sample output (truncated):
camera_id 14d3bd
camera_lens_serial_number HA0028608
camera_serial_number 12070048413
coordinates_mount_dec -6.229778
coordinates_mount_ra 76.0815
exptime 120.0
field_name Wasp 35
num_images 28.0
sequence_id PAN001_14d3bd_20180113T052325
software_version POCSv0.6.0
time 2018-01-13 05:23:25+00:00
total_exptime 3360.0
unit_id PAN001
Name: 6121, dtype: object
```
### Downloading images
The `ObservationInfo` object makes it easy to download the files:
```py
obs_info.download_images()
```
### Command-line tools
There is a simple command line tool that allows for both searching and downloading of images and metadata.
#### Search for observations:
```bash
panoptes-data search --name M42 --min-num-images 90
```
Example table output:
```text
| sequence_id | field_name | unit_id | coordinates_mount_ra | coordinates_mount_dec | num_images | exptime | total_exptime | time |
|:------------------------------|:-------------|:----------|-----------------------:|------------------------:|-------------:|----------:|----------------:|:--------------------------|
| PAN022_977c86_20220108T090553 | M42 | PAN022 | 83.8221 | -5.39111 | 95 | 90 | 8550 | 2022-01-08 09:05:53+00:00 |
| PAN022_538cc6_20220108T090553 | M42 | PAN022 | 83.8221 | -5.39111 | 95 | 89 | 8455 | 2022-01-08 09:05:53+00:00 |
| PAN019_42433a_20220114T085722 | M42 | PAN019 | 83.8221 | -5.39111 | 90 | 90 | 8100 | 2022-01-14 08:57:22+00:00 |
| PAN019_c623e9_20220114T085722 | M42 | PAN019 | 83.8221 | -5.39111 | 90 | 89.0222 | 8012 | 2022-01-14 08:57:22+00:00 |
| PAN019_c623e9_20220115T082108 | M42 | PAN019 | 83.8221 | -5.39111 | 105 | 89.019 | 9347 | 2022-01-15 08:21:08+00:00 |
| PAN019_42433a_20220115T082108 | M42 | PAN019 | 83.8221 | -5.39111 | 105 | 90.0095 | 9451 | 2022-01-15 08:21:08+00:00 |
```
#### Downloading all images for an observation:
```bash
panoptes-data download PAN022_977c86_20220108T090553
```
#### Get all metadata for a unit in a given date range:
```bash
panoptes-data get-metadata --unit-id PAN022 --start-date '2022-01-08'
```
See `panoptes-data --help` for more options.
Raw data
{
"_id": null,
"home_page": null,
"name": "panoptes-data",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "astronomy, data, panoptes",
"author": null,
"author_email": "Wilfred Tyler Gee <wtylergee@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/b2/22/0163c39e99c6c6cc16072dd34440d1e7c1f29aa7abc8adf1f8101d1e3bcf/panoptes_data-0.2.3.tar.gz",
"platform": null,
"description": "[](https://panoptes-data.readthedocs.io/en/latest/?badge=latest)\n\n# PANOPTES Data tools\n\nTools for searching and downloading PANOPTES data.\n\n## Install\n\nInstall from pip:\n\n```bash\npip install panoptes-data\n```\n\n## Examples\n\nSee the example Jupyter Notebooks in the `notebooks/` directory.\n\n### Finding observations\n\n```py\nfrom panoptes.data.search import search_observations\nfrom panoptes.data.observations import ObservationInfo\n\n# Find some observations\nresults = search_observations(by_name='M42')\n\n# Use last result entry to create ObservationInfo object.\nobs_info = ObservationInfo(meta=results.iloc[0])\nprint(obs_info.meta)\n\n# Create an ObservationInfo object directly from a sequence_id.\nobs_info = ObservationInfo('PAN001_14d3bd_20180113T052325')\n# But then there is no metadata:\nprint(obs_info.meta)\n```\n\n```text\nSample output (truncated):\n\ncamera_id 14d3bd\ncamera_lens_serial_number HA0028608\ncamera_serial_number 12070048413\ncoordinates_mount_dec -6.229778\ncoordinates_mount_ra 76.0815\nexptime 120.0\nfield_name Wasp 35\nnum_images 28.0\nsequence_id PAN001_14d3bd_20180113T052325\nsoftware_version POCSv0.6.0\ntime 2018-01-13 05:23:25+00:00\ntotal_exptime 3360.0\nunit_id PAN001\nName: 6121, dtype: object\n```\n\n### Downloading images\n\nThe `ObservationInfo` object makes it easy to download the files:\n\n```py\nobs_info.download_images()\n```\n\n### Command-line tools\n\nThere is a simple command line tool that allows for both searching and downloading of images and metadata.\n\n#### Search for observations:\n\n```bash\npanoptes-data search --name M42 --min-num-images 90\n```\n\nExample table output:\n\n```text\n| sequence_id | field_name | unit_id | coordinates_mount_ra | coordinates_mount_dec | num_images | exptime | total_exptime | time |\n|:------------------------------|:-------------|:----------|-----------------------:|------------------------:|-------------:|----------:|----------------:|:--------------------------|\n| PAN022_977c86_20220108T090553 | M42 | PAN022 | 83.8221 | -5.39111 | 95 | 90 | 8550 | 2022-01-08 09:05:53+00:00 |\n| PAN022_538cc6_20220108T090553 | M42 | PAN022 | 83.8221 | -5.39111 | 95 | 89 | 8455 | 2022-01-08 09:05:53+00:00 |\n| PAN019_42433a_20220114T085722 | M42 | PAN019 | 83.8221 | -5.39111 | 90 | 90 | 8100 | 2022-01-14 08:57:22+00:00 |\n| PAN019_c623e9_20220114T085722 | M42 | PAN019 | 83.8221 | -5.39111 | 90 | 89.0222 | 8012 | 2022-01-14 08:57:22+00:00 |\n| PAN019_c623e9_20220115T082108 | M42 | PAN019 | 83.8221 | -5.39111 | 105 | 89.019 | 9347 | 2022-01-15 08:21:08+00:00 |\n| PAN019_42433a_20220115T082108 | M42 | PAN019 | 83.8221 | -5.39111 | 105 | 90.0095 | 9451 | 2022-01-15 08:21:08+00:00 |\n```\n\n#### Downloading all images for an observation:\n\n```bash\npanoptes-data download PAN022_977c86_20220108T090553\n```\n\n#### Get all metadata for a unit in a given date range:\n\n```bash\npanoptes-data get-metadata --unit-id PAN022 --start-date '2022-01-08'\n```\n\nSee `panoptes-data --help` for more options.\n",
"bugtrack_url": null,
"license": "The MIT License (MIT)\n \n Copyright (c) 2022 Wilfred Tyler Gee\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Tools for working with PANOPTES data.",
"version": "0.2.3",
"project_urls": {
"Documentation": "https://projectpanoptes.org/",
"Download": "https://pypi.org/project/panoptes-data/#files",
"Source": "https://github.com/panoptes/panoptes-data/"
},
"split_keywords": [
"astronomy",
" data",
" panoptes"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c88f73e85acbc5eb09294c27fc4d6debf21c88ab2f6fd0214561e7a6f115ff5f",
"md5": "9cab618a219186bc78e8db46b8d9bdca",
"sha256": "77cb66178c4883dca4b3fa8c59b19e06882130b5668fcc3a3aa3ff33ab87b2b6"
},
"downloads": -1,
"filename": "panoptes_data-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9cab618a219186bc78e8db46b8d9bdca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 12093,
"upload_time": "2025-10-20T22:22:59",
"upload_time_iso_8601": "2025-10-20T22:22:59.403872Z",
"url": "https://files.pythonhosted.org/packages/c8/8f/73e85acbc5eb09294c27fc4d6debf21c88ab2f6fd0214561e7a6f115ff5f/panoptes_data-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b2220163c39e99c6c6cc16072dd34440d1e7c1f29aa7abc8adf1f8101d1e3bcf",
"md5": "7799782ea9ed7605a7fcc52695a77e3e",
"sha256": "bd2e123c5dcaa8f1c80bd076da51574fb2c91a8e00dc6267c656ddf153e49d69"
},
"downloads": -1,
"filename": "panoptes_data-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "7799782ea9ed7605a7fcc52695a77e3e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 9565,
"upload_time": "2025-10-20T22:23:00",
"upload_time_iso_8601": "2025-10-20T22:23:00.385899Z",
"url": "https://files.pythonhosted.org/packages/b2/22/0163c39e99c6c6cc16072dd34440d1e7c1f29aa7abc8adf1f8101d1e3bcf/panoptes_data-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-20 22:23:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "panoptes",
"github_project": "panoptes-data",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "panoptes-data"
}
