panoptes-data 0.2.0__tar.gz → 0.2.3__tar.gz

{panoptes_data-0.2.0 → panoptes_data-0.2.3}/PKG-INFO

@@ -1,25 +1,47 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: panoptes-data
-Version: 0.2.0
+Version: 0.2.3
 Summary: Tools for working with PANOPTES data.
-Home-page: https://github.com/panoptes/panoptes-data
-Author: Wilfred Tyler Gee
-Author-email: wtylergee@gmail.com
-License: MIT
 Project-URL: Documentation, https://projectpanoptes.org/
 Project-URL: Source, https://github.com/panoptes/panoptes-data/
 Project-URL: Download, https://pypi.org/project/panoptes-data/#files
-Platform: any
+Author-email: Wilfred Tyler Gee <wtylergee@gmail.com>
+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.
+License-File: AUTHORS.md
+License-File: LICENSE.txt
+Keywords: astronomy,data,panoptes
 Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Description-Content-Type: text/markdown; charset=UTF-8
-License-File: LICENSE.txt
-Requires-Dist: importlib-metadata; python_version < "3.8"
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
 Requires-Dist: astropy
 Requires-Dist: numpy
 Requires-Dist: pandas
 Requires-Dist: panoptes-utils[images]
-Requires-Dist: pip
 Requires-Dist: pydantic
 Requires-Dist: pydantic-settings
 Requires-Dist: python-dateutil
@@ -27,11 +49,7 @@ Requires-Dist: rich[jupyter]
 Requires-Dist: tabulate
 Requires-Dist: tqdm
 Requires-Dist: typer
-Provides-Extra: testing
-Requires-Dist: setuptools; extra == "testing"
-Requires-Dist: pytest; extra == "testing"
-Requires-Dist: pytest-cov; extra == "testing"
-Requires-Dist: tox; extra == "testing"
+Description-Content-Type: text/markdown
 
 [![Documentation Status](https://readthedocs.org/projects/panoptes-data/badge/?version=latest)](https://panoptes-data.readthedocs.io/en/latest/?badge=latest)
 
@@ -49,20 +67,29 @@ pip install panoptes-data
 
 ## Examples
 
-> See example Jupyter Notebooks in the [`notebooks`](notebooks/) folder.
+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
+from panoptes.data.search import search_observations
+from panoptes.data.observations import ObservationInfo
+
+# Find some observations
+results = search_observations(by_name='M42')
 
->>> # 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)
+```
 
->>> # Use last result entry to create ObservationInfo object.
->>> obs_info = ObservationInfo(meta=results.iloc[0])
->>> obs_info.meta
+```text
+Sample output (truncated):
 
 camera_id                                           14d3bd
 camera_lens_serial_number                        HA0028608
@@ -78,13 +105,6 @@ time                             2018-01-13 05:23:25+00:00
 total_exptime                                       3360.0
 unit_id                                             PAN001
 Name: 6121, dtype: object
-
->>> # Create an ObservationInfo object directly from a sequence_id.
->>> obs_info = ObservationInfo('PAN001_14d3bd_20180113T052325')
->>> # But then there is no metadata:
->>> obs_info.meta
-
-{}
 ```
 
 ### Downloading images
@@ -92,7 +112,7 @@ Name: 6121, dtype: object
 The `ObservationInfo` object makes it easy to download the files:
 
 ```py
->>> obs_info.download_images()
+obs_info.download_images()
 ```
 
 ### Command-line tools
@@ -102,8 +122,12 @@ There is a simple command line tool that allows for both searching and downloadi
 #### Search for observations:
 
 ```bash
-$ panoptes-data search --name M42 --min-num-images 90
+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 |

{panoptes_data-0.2.0 → panoptes_data-0.2.3}/README.md

@@ -14,20 +14,29 @@ pip install panoptes-data
 
 ## Examples
 
-> See example Jupyter Notebooks in the [`notebooks`](notebooks/) folder.
+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
+from panoptes.data.search import search_observations
+from panoptes.data.observations import ObservationInfo
 
->>> # Find some observations
->>> results = search_observations(by_name='M42')
+# Find some observations
+results = search_observations(by_name='M42')
 
->>> # Use last result entry to create ObservationInfo object.
->>> obs_info = ObservationInfo(meta=results.iloc[0])
->>> obs_info.meta
+# 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
@@ -43,13 +52,6 @@ time                             2018-01-13 05:23:25+00:00
 total_exptime                                       3360.0
 unit_id                                             PAN001
 Name: 6121, dtype: object
-
->>> # Create an ObservationInfo object directly from a sequence_id.
->>> obs_info = ObservationInfo('PAN001_14d3bd_20180113T052325')
->>> # But then there is no metadata:
->>> obs_info.meta
-
-{}
 ```
 
 ### Downloading images
@@ -57,7 +59,7 @@ Name: 6121, dtype: object
 The `ObservationInfo` object makes it easy to download the files:
 
 ```py
->>> obs_info.download_images()
+obs_info.download_images()
 ```
 
 ### Command-line tools
@@ -67,8 +69,12 @@ There is a simple command line tool that allows for both searching and downloadi
 #### Search for observations:
 
 ```bash
-$ panoptes-data search --name M42 --min-num-images 90
+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 |

panoptes_data-0.2.3/pyproject.toml

@@ -0,0 +1,80 @@
+[build-system]
+requires = ["hatchling>=1.18", "hatch-vcs>=0.3"]
+build-backend = "hatchling.build"
+
+[project]
+name = "panoptes-data"
+description = "Tools for working with PANOPTES data."
+readme = "README.md"
+requires-python = ">=3.12"
+license = { file = "LICENSE.txt" }
+authors = [
+    { name = "Wilfred Tyler Gee", email = "wtylergee@gmail.com" },
+]
+keywords = ["astronomy", "panoptes", "data"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "astropy",
+    "numpy",
+    "pandas",
+    "panoptes-utils[images]",
+    "pydantic",
+    "pydantic-settings",
+    "python-dateutil",
+    "rich[jupyter]",
+    "tabulate",
+    "tqdm",
+    "typer",
+]
+dynamic = ["version"]
+
+[project.urls]
+Documentation = "https://projectpanoptes.org/"
+Source = "https://github.com/panoptes/panoptes-data/"
+Download = "https://pypi.org/project/panoptes-data/#files"
+
+[project.scripts]
+panoptes-data = "panoptes.data.utils.cli.main:app"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build]
+include = ["src/panoptes/**", "README.md", "LICENSE.txt"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/panoptes"]
+
+[tool.hatch.envs.default]
+dependencies = [
+    "ruff>=0.5.0"
+]
+[tool.hatch.envs.default.scripts]
+lint = "ruff check ."
+lint-fix = "ruff check --fix ."
+fmt = "ruff format ."
+fmt-check = "ruff format --check ."
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+src = ["src"]
+
+[tool.hatch.envs.tests]
+dependencies = [
+    "coverage>=7.0,<8.0",
+    "pytest>=7.0,<8.0",
+    "pytest-cov>=4.0,<5.0",
+    "pytest-doctestplus>=1.0,<2.0",
+]
+[tool.hatch.envs.tests.scripts]
+test = "pytest"
+test-cov = "pytest --cov=panoptes.data --cov-report term-missing --verbose"

{panoptes_data-0.2.0 → panoptes_data-0.2.3}/src/panoptes/data/observations.py

@@ -1,35 +1,19 @@
 import shutil
 import warnings
-from enum import IntEnum, auto
 from pathlib import Path
 
 import pandas as pd
 from astropy.nddata import CCDData, Cutout2D
 from astropy.utils.data import download_file
 from astropy.wcs import FITSFixedWarning
-from panoptes.utils.images import fits as fits_utils
 from tqdm.auto import tqdm
 
 from panoptes.data.settings import CloudSettings
+from panoptes.utils.images import fits as fits_utils
 
 warnings.filterwarnings('ignore', category=FITSFixedWarning)
 
 
-class ObservationStatus(IntEnum):
-    """The status of an observation."""
-    ERROR = auto()
-    NOT_ENOUGH_FRAMES = auto()
-    UNKNOWN = auto()
-    CREATED = auto()
-    RECEIVING = auto()
-    RECEIVED = auto()
-    PROCESSING = auto()
-    CALIBRATING = auto()
-    CALIBRATED = auto()
-    MATCHING = auto()
-    MATCHED = auto()
-
-
 class ObservationInfo:
     """A container class for information about an Observation."""
 

{panoptes_data-0.2.0 → panoptes_data-0.2.3}/src/panoptes/data/search.py

@@ -2,17 +2,16 @@ import logging
 from contextlib import suppress
 from datetime import datetime as dt
 
-import astropy
 import pandas as pd
 from astropy import units as u
 from astropy.coordinates import SkyCoord
 from astropy.utils.data import download_file
 from dateutil.parser import parse as parse_date
-from panoptes.utils.time import current_time
-from panoptes.utils.utils import listify
 
 from panoptes.data.observations import ObservationInfo
 from panoptes.data.settings import CloudSettings
+from panoptes.utils.time import current_time
+from panoptes.utils.utils import listify
 
 logger = logging.getLogger()
 
@@ -85,7 +84,7 @@ def search_observations(
     Returns:
         `pandas.DataFrame`: A table with the matching observation results.
     """
-    logger.debug(f'Setting up search params')
+    logger.debug('Setting up search params')
 
     if coords is None:
         if by_name is not None:
@@ -118,7 +117,7 @@ def search_observations(
     obs_df = source if source is not None else get_all_observations()
 
     # Perform filtering on other fields here.
-    print(f'Filtering observations')
+    print('Filtering observations')
     query_string = (f'`{dec_col}` >= {dec_min} '
                     f'and '
                     f'`{dec_col}` <= {dec_max}'
@@ -202,7 +201,7 @@ def get_metadata(observations: pd.DataFrame) -> pd.DataFrame:
     for idx, rec in observations.iterrows():
         try:
             dfs.append(ObservationInfo(meta=rec).image_metadata)
-        except Exception as e:
+        except Exception:
             pass
 
     return pd.concat(dfs)

panoptes_data-0.2.3/src/panoptes/data/settings.py

@@ -0,0 +1,45 @@
+from enum import IntEnum, auto
+
+from pydantic.networks import AnyHttpUrl
+from pydantic_settings import BaseSettings
+
+
+class CloudSettings(BaseSettings):
+    img_base_url: AnyHttpUrl = 'https://storage.googleapis.com'
+    img_bucket: str = 'panoptes-images-incoming'
+    img_metadata_url: AnyHttpUrl = 'https://us-central1-project-panoptes-01.cloudfunctions.net/get-observation-info'
+    observations_url: AnyHttpUrl = 'https://storage.googleapis.com/panoptes-assets/observations.csv'
+
+
+class ImageStatus(IntEnum):
+    """The status of an image."""
+    ERROR = auto()
+    MASKED = auto()
+    UNKNOWN = auto()
+    RECEIVING = auto()
+    RECEIVED = auto()
+    UNSOLVED = auto()
+    PROCESSING = auto()
+    CALIBRATING = auto()
+    CALIBRATED = auto()
+    SOLVING = auto()
+    SOLVED = auto()
+    MATCHING = auto()
+    MATCHED = auto()
+    EXTRACTING = auto()
+    EXTRACTED = auto()
+
+
+class ObservationStatus(IntEnum):
+    """The status of an observation."""
+    ERROR = auto()
+    NOT_ENOUGH_FRAMES = auto()
+    UNKNOWN = auto()
+    CREATED = auto()
+    RECEIVING = auto()
+    RECEIVED = auto()
+    PROCESSING = auto()
+    CALIBRATING = auto()
+    CALIBRATED = auto()
+    MATCHING = auto()
+    MATCHED = auto()

{panoptes_data-0.2.0 → panoptes_data-0.2.3}/src/panoptes/data/utils/cli/main.py

@@ -1,21 +1,20 @@
 from pathlib import Path
-from typing import List, Union
 
 import pandas as pd
 import typer
 from astropy.time import Time
-from panoptes.utils.time import current_time, flatten_time
 from rich import print
 from tqdm import tqdm
 
 from panoptes.data.observations import ObservationInfo
 from panoptes.data.search import search_observations
+from panoptes.utils.time import current_time, flatten_time
 
 app = typer.Typer(pretty_exceptions_enable=False)
 
 
 @app.command()
-def download(sequence_id: Union[str, None] = typer.Argument(..., help='Sequence ID for the Observation.'),
+def download(sequence_id: str | None = typer.Argument(..., help='Sequence ID for the Observation.'),
              output_dir: Path = typer.Option(
                  None,
                  '--output-dir', '-o',
@@ -26,7 +25,7 @@ def download(sequence_id: Union[str, None] = typer.Argument(..., help='Sequence
                  '--image-query', '-q',
                  help='Query for images, default \'status!="ERROR"\''
              ),
-             ) -> List[str]:
+             ) -> list[str]:
     """Downloads all FITS images for the observation."""
     local_files = list()
 
@@ -49,20 +48,20 @@ def download(sequence_id: Union[str, None] = typer.Argument(..., help='Sequence
 
 @app.command()
 def get_metadata(
-    sequence_id: Union[str, None] = typer.Option(
+    sequence_id: str | None = typer.Option(
         None, '--sequence-id', '-s',
         help='Sequence ID for the Observation.'
     ),
-    unit_id: Union[str, None] = typer.Option(
+    unit_id: str | None = typer.Option(
         None, '--unit-id', '-u',
         help='Unit ID for the Observation. '
              'Use with a date range to download all metadata for a unit.'
     ),
-    start_date: Union[str, None] = typer.Option(
+    start_date: str | None = typer.Option(
         None, '--start-date', '-s',
         help='Start date for downloading metadata in form YYYY-MM-DD'
     ),
-    end_date: Union[str, None] = typer.Option(
+    end_date: str | None = typer.Option(
         None, '--end-date', '-s',
         help='End date for downloading metadata, defaults to now.'
     ),
@@ -115,7 +114,7 @@ def get_metadata(
                 try:
                     pbar.set_description(f'Getting metadata for {rec["sequence_id"]}')
                     dfs.append(ObservationInfo(meta=rec).image_metadata)
-                except Exception as e:
+                except Exception:
                     pbar.write(f'Error in {idx} {rec["sequence_id"]}')
 
             pd.concat(dfs).to_csv(output_fn)

panoptes_data-0.2.0/.coveragerc

@@ -1,28 +0,0 @@
-# .coveragerc to control coverage.py
-[run]
-branch = True
-source = panoptes.data
-# omit = bad_file.py
-
-[paths]
-source =
-    src/
-    */site-packages/
-
-[report]
-# Regexes for lines to exclude from consideration
-exclude_lines =
-    # Have to re-enable the standard pragma
-    pragma: no cover
-
-    # Don't complain about missing debug-only code:
-    def __repr__
-    if self\.debug
-
-    # Don't complain if tests don't hit defensive assertion code:
-    raise AssertionError
-    raise NotImplementedError
-
-    # Don't complain if non-runnable code isn't run:
-    if 0:
-    if __name__ == .__main__.:

panoptes_data-0.2.0/.github/workflows/create-release.yml

@@ -1,50 +0,0 @@
-# This will create a release for any properly tagged branch.
-on:
-  push:
-    # Sequence of patterns matched against refs/tags
-    tags:
-      - 'v[0-9].[0-9]+.[0-9]+' # Push events to matching vX.Y.Z, but not vX.Y.Zdev
-
-name: Create GitHub Release
-
-jobs:
-  build:
-    name: Create Release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Create Release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
-          body: |
-            See Changelog for details
-          draft: false
-          prerelease: false
-  deploy:
-    name: Push Release to PyPi
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: '3.x'
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install ".[testing]"
-      - name: tox clean and build
-        run: |
-          tox -e clean
-          tox -e build
-      - name: Publish package
-        uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}          

panoptes_data-0.2.0/.isort.cfg

@@ -1,3 +0,0 @@
-[settings]
-profile = black
-known_first_party = panoptes

panoptes_data-0.2.0/.pre-commit-config.yaml

@@ -1,67 +0,0 @@
-exclude: '^docs/conf.py'
-
-repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
-  hooks:
-  - id: trailing-whitespace
-  - id: check-added-large-files
-  - id: check-ast
-  - id: check-json
-  - id: check-merge-conflict
-  - id: check-xml
-  - id: check-yaml
-  - id: debug-statements
-  - id: end-of-file-fixer
-  - id: requirements-txt-fixer
-  - id: mixed-line-ending
-    args: ['--fix=auto']  # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
-
-## If you want to automatically "modernize" your Python code:
-# - repo: https://github.com/asottile/pyupgrade
-#   rev: v3.7.0
-#   hooks:
-#   - id: pyupgrade
-#     args: ['--py37-plus']
-
-## If you want to avoid flake8 errors due to unused vars or imports:
-# - repo: https://github.com/PyCQA/autoflake
-#   rev: v2.1.1
-#   hooks:
-#   - id: autoflake
-#     args: [
-#       --in-place,
-#       --remove-all-unused-imports,
-#       --remove-unused-variables,
-#     ]
-
-- repo: https://github.com/PyCQA/isort
-  rev: 5.11.5
-  hooks:
-  - id: isort
-
-- repo: https://github.com/psf/black
-  rev: stable
-  hooks:
-  - id: black
-    language_version: python3
-
-## If like to embrace black styles even in the docs:
-# - repo: https://github.com/asottile/blacken-docs
-#   rev: v1.13.0
-#   hooks:
-#   - id: blacken-docs
-#     additional_dependencies: [black]
-
-- repo: https://github.com/PyCQA/flake8
-  rev: 5.0.4
-  hooks:
-  - id: flake8
-  ## You can add flake8 plugins via `additional_dependencies`:
-  #  additional_dependencies: [flake8-bugbear]
-
-## Check for misspells in documentation files:
-# - repo: https://github.com/codespell-project/codespell
-#   rev: v2.2.5
-#   hooks:
-#   - id: codespell

panoptes_data-0.2.0/.readthedocs.yaml

@@ -1,23 +0,0 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Set the OS, Python version and other tools you might need
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.12"
-
-# Build documentation in the "docs/" directory with Sphinx
-sphinx:
-  configuration: docs/conf.py
-
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-python:
-  install:
-    - requirements: docs/requirements.txt
-    - method: pip
-      path: .