wintertoo 0.2.1__tar.gz → 0.4.2__tar.gz

wintertoo-0.4.2/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

wintertoo-0.4.2/.github/workflows/automerge.yml

@@ -0,0 +1,30 @@
+name: Dependabot auto-merge
+
+on:
+  pull_request:
+  merge_group:
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.1.1
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Echo auto-merge
+        run: echo "Update type is ${{steps.metadata.outputs.update-type}}, check is ${{contains(steps.metadata.outputs.update-type,'version-update:semver')}}"
+
+      - name: Enable auto-merge for Dependabot PRs
+        if: ${{contains(steps.metadata.outputs.update-type,'version-update:semver')}}
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

wintertoo-0.4.2/.github/workflows/black.yml

@@ -0,0 +1,25 @@
+name: Black
+
+on: [push, pull_request]
+
+jobs:
+  black:
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install poetry
+        run: pipx install poetry
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install --editable ".[dev]"
+      - name: Reformat the code with black
+        run: |
+          black . --check

wintertoo-0.4.2/.github/workflows/continuous_integration.yml

@@ -0,0 +1,77 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events
+  push:
+
+  pull_request:
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Specify the python versions to test
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      - uses: actions/checkout@v3
+
+      # Set up the python versions
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+
+      - name: install packages
+        run: |
+          pip install --editable ".[dev]"
+
+      # Runs a set of commands using the runners shell
+      - name: Test the code
+        run: |
+          coverage run -m unittest discover tests/
+
+      - name: Run Coveralls
+        env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+            coveralls --service=github
+
+
+      - name: Echo tag name
+        run: echo "Tag is ${{ github.ref }}, Tagged is ${{ startsWith(github.ref, 'refs/tags/')}}, Python Check is ${{matrix.python-version == 3.9}},  Deploy is ${{ startsWith(github.ref, 'refs/tags/') && matrix.python-version == 3.9}}"
+
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+
+      - name: Publish distribution 📦 to PyPI
+        if: ${{ startsWith(github.ref, 'refs/tags/') && success() && matrix.python-version == 3.9 && github.event_name == 'push'}}
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

wintertoo-0.4.2/.github/workflows/isort.yml

@@ -0,0 +1,21 @@
+name: Run isort
+
+on: [push, pull_request]
+
+jobs:
+  isort:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.11
+        cache: 'pip'
+        cache-dependency-path: pyproject.toml
+    - name: Install dependencies
+      run: |
+        pip install --upgrade pip
+        pip install --editable ".[dev]"
+    - name: isort
+      uses: isort/isort-action@v1.0.0

wintertoo-0.4.2/.github/workflows/pylint.yml

@@ -0,0 +1,24 @@
+name: Pylint
+
+on: [push, pull_request]
+
+jobs:
+  pylint:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+          cache: 'pip'
+          cache-dependency-path: pyproject.toml
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install --editable ".[dev]"
+      - name: Analysing the code with pylint
+        run: |
+           pylint wintertoo --fail-under=10.00

wintertoo-0.4.2/.gitignore

@@ -0,0 +1,20 @@
+.env
+__pycache__/
+*.pyc
+.DS_Store
+.idea/
+
+# Distribution / packaging
+bin/
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg

wintertoo-0.4.2/.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+-   repo: local
+    hooks:
+    -   id: black
+        name: black
+        entry: black
+        language: system
+        types: [ python ]
+-   repo: local
+    hooks:
+      - id: isort
+        name: isort (python)
+        entry: isort
+        language: system
+        types: [ python ]
+-   repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types: [python]
+        args:
+          [
+            "-rn", # Only display messages
+            "-sn", # Don't display the score
+          ]
+        verbose: true

{wintertoo-0.2.1 → wintertoo-0.4.2}/PKG-INFO

@@ -1,19 +1,26 @@
 Metadata-Version: 2.1
 Name: wintertoo
-Version: 0.2.1
-Home-page: https://github.com/winter-telescope/wintertoo
-Author: Danielle Frostig, Viraj Karambelkar, Robert Stein
+Version: 0.4.2
+Author-email: Robert Stein <rdstein@caltech.edu>, Danielle Frostig <frostig@mit.edu>, Viraj Karambelkar <viraj@astro.caltech.edu>
 License: MIT
-Keywords: astronomy image WINTER
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
+Project-URL: homepage, https://github.com/winter-telescope/wintertoo
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
-Requires-Python: >=3.7
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
+Provides-Extra: dev
 License-File: LICENSE
 
 # wintertoo
@@ -27,3 +34,17 @@ Current functionality includes:
 * Converting RA/DEC positions to fields
 * Building ToO schedules
 * Verifying ToO schedules
+
+## Installation
+### Install from pypi
+```bash
+pip install wintertoo
+```
+
+### Install from source
+```bash
+git clone git@github.com:winter-telescope/wintertoo.git
+cd wintertoo
+pip install --editable ".[dev]"
+pre-commit install
+```

{wintertoo-0.2.1 → wintertoo-0.4.2}/README.md

@@ -9,3 +9,17 @@ Current functionality includes:
 * Converting RA/DEC positions to fields
 * Building ToO schedules
 * Verifying ToO schedules
+
+## Installation
+### Install from pypi
+```bash
+pip install wintertoo
+```
+
+### Install from source
+```bash
+git clone git@github.com:winter-telescope/wintertoo.git
+cd wintertoo
+pip install --editable ".[dev]"
+pre-commit install
+```

wintertoo-0.4.2/pyproject.toml

@@ -0,0 +1,98 @@
+[build-system]
+requires = ["setuptools>=45", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "wintertoo"
+version = "0.4.2"
+description = ""
+authors = [
+    {name = "Robert Stein", email = "rdstein@caltech.edu"},
+    {name = "Danielle Frostig", email = "frostig@mit.edu"},
+    {name = "Viraj Karambelkar", email = "viraj@astro.caltech.edu"}
+]
+license = {text = "MIT"}
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Intended Audience :: Science/Research',
+    'Intended Audience :: End Users/Desktop',
+    'Intended Audience :: Developers',
+    'Natural Language :: English',
+    'Topic :: Scientific/Engineering',
+    'Topic :: Scientific/Engineering :: Astronomy',
+    'Topic :: Scientific/Engineering :: Physics',
+    'Operating System :: POSIX',
+    'Operating System :: Unix',
+    'Operating System :: MacOS',
+]
+dependencies = [
+    "pandas",
+    "astropy",
+    "astroplan",
+    "matplotlib",
+    "numpy",
+    "pytz",
+    "jsonschema",
+    "sqlalchemy",
+    "pydantic>=2.2.0",
+    "pre-commit",
+    "bcrypt",
+    "psycopg",
+    "psycopg-binary"
+]
+[project.optional-dependencies]
+dev = [
+    "black == 23.7.0",
+    "isort == 5.12.0",
+    "pylint == 2.17.5",
+    "coveralls",
+]
+
+[project.urls]
+homepage = "https://github.com/winter-telescope/wintertoo"
+
+[tool.setuptools]
+packages = ["wintertoo", "wintertoo.models", "wintertoo.data"]
+
+[tool.coverage.run]
+source = ["wintertoo"]
+
+[tool.coverage.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__",
+    # Don't complain if tests don't hit defensive assertion code:
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "raise KeyError",
+    "except KeyError",
+    "raise ValueError",
+    "except JSONDecodeError:",
+    "raise requests.exceptions.RequestException",
+    # Don't complain if non-runnable code isn't run:
+    "if 0:",
+    "if False:",
+    'if __name__ == "__main__":',
+    "err =",
+    "logger.error",
+    "raise"
+    ]
+ignore_errors = true
+
+[tool.isort]
+profile = "black"
+
+[tool.pylint.format]
+max-line-length = "88"
+disable=["logging-fstring-interpolation"]
+good-names=["ax", "ra", "df", "pi", "i"]
+exclude-too-few-public-methods=["pydantic.*"]
+extension-pkg-whitelist=["pydantic"]

wintertoo-0.4.2/tests/test_fields.py

@@ -0,0 +1,58 @@
+"""
+Module for testing submission of a schedule
+"""
+import logging
+import unittest
+
+from wintertoo.fields import get_best_field, get_field_info, get_fields_in_box
+
+logger = logging.getLogger(__name__)
+
+
+class TestField(unittest.TestCase):
+    """
+    Class for schedule testing
+    """
+
+    def test_get_fields_in_box(self):
+        """
+        Test getting fields in box
+
+        :return: None
+        """
+        logger.info("Testing getting fields in box")
+
+        ra_deg = 210.910674637
+        dec_deg = 54.3116510708
+
+        width = 0.7
+
+        ra_lim = (ra_deg - width, ra_deg + width)
+        dec_lim = (dec_deg - width, dec_deg + width)
+
+        fields = get_fields_in_box(ra_lim, dec_lim, summer=True)
+
+        assert len(fields) == 28, f"Wrong number of fields ({len(fields)})"
+        assert fields["ID"].iloc[0] == 54494, f"Wrong field {fields['ID'].iloc[0]}"
+
+        fields = get_fields_in_box(ra_lim, dec_lim, summer=False)
+
+        assert len(fields) == 3, f"Wrong number of fields ({len(fields)})"
+        assert fields["ID"].iloc[0] == 3735, f"Wrong field {fields['ID'].iloc[0]}"
+
+    def test_get_field_info(self):
+        """
+        Test getting field info
+
+        :return: None
+        """
+        get_field_info(55286, summer=True)
+        get_field_info(3735, summer=False)
+
+    def test_get_best_field(self):
+        """
+        Test getting best field
+
+        :return: None
+        """
+        get_best_field(210.910674637, 54.3116510708, summer=True, make_plot=True)

wintertoo-0.4.2/tests/test_schedule.py

@@ -0,0 +1,127 @@
+"""
+Module for testing submission of a schedule
+"""
+import logging
+import os
+import unittest
+from datetime import date
+
+import pandas as pd
+from astropy.time import Time
+
+from wintertoo.models import Program, SummerFieldToO, SummerRaDecToO
+from wintertoo.schedule import concat_toos, schedule_field, schedule_ra_dec
+from wintertoo.submit import export_schedule_to_sqlitedb
+from wintertoo.validate import (
+    validate_obshist,
+    validate_schedule_df,
+    validate_target_dates,
+    validate_target_pi,
+    validate_target_priority,
+    validate_target_visibility,
+)
+
+logger = logging.getLogger(__name__)
+
+test_data_dir = os.path.join(os.path.dirname(__file__), "testdata")
+test_json_path = os.path.join(test_data_dir, "test_schedule.json")
+test_df = pd.read_json(test_json_path)
+
+program = Program(
+    pi_name="Stein",
+    progname="2021A000",
+    prog_key="763244309190298696786072636901190268976229595667748695826878",
+    maxpriority=100,
+    startdate=date(2021, 1, 1),
+    enddate=date(2023, 12, 31),
+)
+
+
+class TestSchedule(unittest.TestCase):
+    """
+    Class for schedule testing
+    """
+
+    def test_validate_json(self):
+        """
+        Test validation of json
+
+        :return: None
+        """
+        logger.info("Testing the validation with a test json")
+        validate_schedule_df(test_df)
+
+    def test_generate_schedule(self):
+        """
+        Test generating a schedule
+
+        :return: None
+        """
+        logger.info("Testing schedule generation")
+
+        schedule = schedule_ra_dec(
+            too=SummerRaDecToO(
+                ra_deg=173.7056754,
+                dec_deg=11.253441,
+                start_time_mjd=62721.1894969287,
+                end_time_mjd=62722.1894969452,
+            ),
+            program=program,
+        )
+
+        # Uncomment to generate a new test json
+        # schedule.to_json(test_json_path)
+
+        validate_target_visibility(schedule)
+
+        comp = pd.read_json(schedule.to_json())  # pylint: disable=no-member
+        self.assertEqual(test_df.to_json(), comp.to_json())  # pylint: disable=no-member
+
+        schedule = schedule_ra_dec(
+            too=SummerRaDecToO(
+                ra_deg=173.7056754,
+                dec_deg=11.253441,
+            ),
+            program=program,
+        )
+
+        validate_schedule_df(schedule)
+        validate_obshist(schedule)
+
+        validate_target_priority(schedule=schedule, max_priority=program.maxpriority)
+
+        program_start_date = Time(str(program.startdate), format="isot")
+
+        program_end_date = Time(str(program.enddate), format="isot")
+
+        validate_target_dates(
+            schedule,
+            program_start_date=program_start_date,
+            program_end_date=program_end_date,
+        )
+        validate_target_pi(schedule, prog_pi=program.pi_name)
+
+        export_schedule_to_sqlitedb(schedule, "test_schedule.db")
+
+    def test_schedule_utils(self):
+        """
+        Test generating a schedule
+
+        :return: None
+        """
+        logger.info("Testing schedule util functions")
+
+        field_too = SummerFieldToO(
+            field_id=1,
+        )
+
+        schedule_field(
+            field_too,
+            program=program,
+            csv_save_file="test_schedule.csv",
+        )
+
+        concat_toos(
+            [field_too, SummerRaDecToO(ra_deg=173.7056754, dec_deg=11.253441)],
+            program=program,
+        )

wintertoo-0.4.2/tests/testdata/test_schedule.json

@@ -0,0 +1 @@
+{"raDeg":{"0":173.60947,"1":173.60947,"2":173.60947,"3":173.60947},"decDeg":{"0":11.16715,"1":11.16715,"2":11.16715,"3":11.16715},"fieldID":{"0":244641,"1":244641,"2":244641,"3":244641},"filter":{"0":"u","1":"g","2":"r","3":"i"},"visitExpTime":{"0":30.0,"1":30.0,"2":30.0,"3":30.0},"priority":{"0":50.0,"1":50.0,"2":50.0,"3":50.0},"progPI":{"0":"Stein","1":"Stein","2":"Stein","3":"Stein"},"progName":{"0":"2021A000","1":"2021A000","2":"2021A000","3":"2021A000"},"progID":{"0":1,"1":1,"2":1,"3":1},"validStart":{"0":62721.1894969287,"1":62721.1894969287,"2":62721.1894969287,"3":62721.1894969287},"validStop":{"0":62722.1894969452,"1":62722.1894969452,"2":62722.1894969452,"3":62722.1894969452},"observed":{"0":false,"1":false,"2":false,"3":false},"maxAirmass":{"0":2.0,"1":2.0,"2":2.0,"3":2.0},"ditherNumber":{"0":1,"1":1,"2":1,"3":1},"ditherStepSize":{"0":600.0,"1":600.0,"2":600.0,"3":600.0},"obsHistID":{"0":0,"1":1,"2":2,"3":3}}

wintertoo-0.4.2/wintertoo/data/__init__.py

@@ -0,0 +1,57 @@
+"""
+Central module for general data and telescope constants
+"""
+import json
+import typing
+from pathlib import Path
+from typing import Literal
+
+import astroplan
+import astropy.coordinates as coords
+import pandas as pd
+
+data_dir = Path(__file__).parent.resolve()
+
+summer_fields_path = data_dir.joinpath("summer_fields.txt")
+summer_fields = pd.read_csv(summer_fields_path, sep=r"\s+")
+
+winter_fields_path = data_dir.joinpath("winter_fields.txt")
+winter_fields = pd.read_csv(winter_fields_path, sep=r"\s+")
+
+SummerFilters = Literal["u", "g", "r", "i"]
+
+WinterFilters = Literal["dark", "Y", "J", "Hs"]
+
+SUMMER_FILTERS = list(typing.get_args(SummerFilters))
+WINTER_FILTERS = list(typing.get_args(WinterFilters))
+WINTER_SCIENCE_FILTERS = ["Y", "J", "Hs"]
+
+SUMMER_BASE_WIDTH = 0.26112
+WINTER_BASE_WIDTH = 1.0
+
+PROGRAM_DB_HOST = "jagati.caltech.edu"
+
+too_schedule_config_path = data_dir.joinpath("observing_request_schema.json")
+
+with open(too_schedule_config_path, "rb") as f:
+    too_db_schedule_config = json.load(f)
+
+
+def get_default_value(key: str):
+    """
+    Get default value for a parameter.
+
+    :param key: Key to check
+    :return: default value
+    """
+    return too_db_schedule_config["properties"][key]["default"]
+
+
+# define location of Palomar Observatory
+PALOMAR_LOC = coords.EarthLocation(
+    lat=coords.Latitude("33d21m25.5s"),
+    lon=coords.Longitude("-116d51m58.4s"),
+    height=1696.0,
+)
+
+palomar_observer = astroplan.Observer(location=PALOMAR_LOC)