wintertoo 1.1.0__py3-none-any.whl → 1.3.0__py3-none-any.whl

wintertoo/data/__init__.py

@@ -30,6 +30,11 @@ WINTER_SCIENCE_FILTERS = ["Y", "J", "Hs"]
 SUMMER_BASE_WIDTH = 0.26112
 WINTER_BASE_WIDTH = 1.0
 
+MAX_TARGNAME_LEN = 30
+
+WinterImageTypes = Literal["exposure", "raw", "science", "stack", "diff"]
+DEFAULT_IMAGE_TYPE = "stack"
+
 PROGRAM_DB_HOST = "jagati.caltech.edu"
 
 too_schedule_config_path = data_dir.joinpath("observing_request_schema.json")

wintertoo/data/observing_request_schema.json

@@ -17,7 +17,8 @@
     "ditherNumber": {"type": "integer", "default": 1},
     "ditherStepSize": {"type": "number", "comment": "arcsec", "default": 30.0},
     "fieldID": {"type": "integer", "default": 999999999},
-    "targName": {"type": ["string", "null"], "comment": "Target name e.g. GW170817"}
+    "targName": {"type": ["string", "null"], "comment": "Target name e.g. GW170817", "default": null},
+    "bestDetector": {"type": "boolean", "comment": "Center Ra/Dec of target on best detector", "default": true}
   },
   "required": [
     "obsHistID",

wintertoo/models/__init__.py

@@ -2,6 +2,13 @@
 Models for the wintertoo
 """
 
+from wintertoo.models.image import (
+    ConeImageQuery,
+    ImagePath,
+    ProgramImageQuery,
+    RectangleImageQuery,
+    TargetImageQuery,
+)
 from wintertoo.models.program import Program, ProgramCredentials
 from wintertoo.models.too import (
     AllTooClasses,

wintertoo/models/image.py

@@ -2,53 +2,80 @@
 Base models for image queries
 """
 
-from typing import Literal
+from typing import Optional
 
 from astropy import units as u
 from astropy.time import Time
 from pydantic import BaseModel, Field, model_validator
 
+from wintertoo.data import DEFAULT_IMAGE_TYPE, MAX_TARGNAME_LEN, WinterImageTypes
 from wintertoo.errors import WinterValidationError
-from wintertoo.models import ProgramCredentials
 from wintertoo.utils import get_date
 
 
-class BaseImageQuery(BaseModel):
+class ImagePath(BaseModel):
+    """
+    Base model for image paths
+    """
+
+    path: str = Field(title="Path to image", min_length=1, example="path/to/image.fits")
+
+
+class ProgramImageQuery(BaseModel):
     """
     Base model for image queries
     """
 
-    program_list: list[ProgramCredentials] = Field(
-        title="List of programs to search for", min_length=1
+    program_name: str = Field(
+        title="Program to search for", min_length=1, examples=["2020A000", "2021B001"]
     )
     start_date: int = Field(
         title="Start date for images",
         le=get_date(Time.now()),
         default=get_date(Time.now() - 30.0 * u.day),
+        examples=[get_date(Time.now() - 30.0 * u.day), "20230601"],
     )
     end_date: int = Field(
         title="End date for images",
         le=get_date(Time.now()),
         default=get_date(Time.now()),
+        examples=[get_date(Time.now() - 30.0 * u.day), get_date(Time.now())],
     )
-    kind: Literal["raw", "science", "diff"] = Field(
-        default="science", title="raw/science/diff"
+    kind: WinterImageTypes = Field(
+        default=DEFAULT_IMAGE_TYPE, example="raw/science/diff"
     )
 
 
-class RectangleImageQuery(BaseImageQuery):
+class TargetImageQuery(ProgramImageQuery):
+    """
+    Model for image queries based on target name
+    """
+
+    target_name: Optional[str] = Field(
+        title="Name of target",
+        min_length=1,
+        max_length=MAX_TARGNAME_LEN,
+        examples=["SN2023ixf", "ZTF19aapreis"],
+    )
+
+
+class RectangleImageQuery(ProgramImageQuery):
     """
     Model for image queries with a rectangular region
     """
 
-    ra_min: float = Field(title="Minimum RA (degrees)", ge=0.0, le=360.0, default=0.0)
-    ra_max: float = Field(title="Minimum RA (degrees)", ge=0.0, le=360.0, default=360.0)
+    ra_min: float = Field(
+        title="Minimum RA (degrees)", ge=0.0, le=360.0, examples=[90.0, 180.0]
+    )
+    ra_max: float = Field(
+        title="Minimum RA (degrees)", ge=0.0, le=360.0, examples=[90.0, 180.0]
+    )
 
     dec_min: float = Field(
-        title="Minimum dec (degrees)", ge=-90.0, le=90.0, default=-90.0
+        title="Minimum dec (degrees)", ge=-90.0, le=90.0, examples=[-30.0, 10.0]
     )
     dec_max: float = Field(
-        title="Minimum dec (degrees)", ge=-90.0, le=90.0, default=90.0
+        title="Minimum dec (degrees)", ge=-90.0, le=90.0, examples=[-30.0, 10.0]
     )
 
     @model_validator(mode="after")
@@ -72,13 +99,17 @@ class RectangleImageQuery(BaseImageQuery):
         return self
 
 
-class ConeImageQuery(BaseImageQuery):
+class ConeImageQuery(ProgramImageQuery):
     """
     Model for image queries with a circular region
     """
 
-    ra: float = Field(title="Center RA (degrees)", ge=0.0, le=360.0, default=0.0)
-    dec: float = Field(title="Center dec (degrees)", ge=-90.0, le=90.0, default=-90.0)
+    ra: float = Field(
+        title="Center RA (degrees)", ge=0.0, le=360.0, examples=[90.0, 180.0]
+    )
+    dec: float = Field(
+        title="Center dec (degrees)", ge=-90.0, le=90.0, examples=[-30.0, 10.0]
+    )
     radius_deg: float = Field(
         title="Search radius in degrees", ge=0.0, le=90.0, default=1.0
     )

wintertoo/models/too.py

@@ -8,6 +8,7 @@ from astropy.time import Time
 from pydantic import BaseModel, ConfigDict, Field, model_validator
 
 from wintertoo.data import (
+    MAX_TARGNAME_LEN,
     SUMMER_FILTERS,
     WINTER_SCIENCE_FILTERS,
     SummerFilters,
@@ -31,6 +32,13 @@ class ToORequest(BaseModel):
         title="Priority for target",
         ge=0.0,
     )
+    target_name: Optional[str] = Field(
+        title="Name of the target",
+        min_length=1,
+        max_length=MAX_TARGNAME_LEN,
+        examples=["SN2021abc", "ZTF19aapreis"],
+        default=get_default_value("targName"),
+    )
     t_exp: float = Field(
         default=get_default_value("visitExpTime"),
         title="Combined Exposure Time across dithers (s)",
@@ -56,6 +64,10 @@ class ToORequest(BaseModel):
         le=5,
         title="Allowed airmass range",
     )
+    use_best_detector: bool = Field(
+        default=get_default_value("bestDetector"),
+        title="Place ra/dec at the center of the best detector",
+    )
 
     @model_validator(mode="after")
     def validate_end_time(self):
@@ -116,9 +128,22 @@ class ObsWithRaDec(BaseModel):
     )
     use_field_grid: bool = Field(
         title="boolean whether to select nearest field in grid for central ra/dec",
-        default=True,
+        default=False,
     )
 
+    @model_validator(mode="after")
+    def validate_field_best_detector(self):
+        """
+        Field validator to ensure that the end time is greater than the start time
+
+        :return: validated field value
+        """
+        if self.use_best_detector & self.use_field_grid:
+            raise WinterValidationError(
+                "Cannot use both use_best_detector and use_field_grid"
+            )
+        return self
+
 
 class ObsWithField(BaseModel):
     """

wintertoo/schedule.py

@@ -45,6 +45,7 @@ def make_schedule(
         for filter_name in too.filters:
             for _ in range(too.n_exp):
                 new = {
+                    "targName": too.target_name,
                     "raDeg": too.ra_deg,
                     "decDeg": too.dec_deg,
                     "fieldID": too.field_id,
@@ -60,6 +61,7 @@ def make_schedule(
                     "maxAirmass": too.max_airmass,
                     "ditherNumber": too.n_dither,
                     "ditherStepSize": too.dither_distance,
+                    "bestDetector": too.use_best_detector,
                 }
                 all_entries.append(new)
 

wintertoo/submit.py

@@ -4,6 +4,7 @@ Module handling submission of ToO schedules
 
 import logging
 from datetime import datetime
+from pathlib import Path
 from typing import Optional
 
 import pandas as pd
@@ -13,8 +14,27 @@ from wintertoo.validate import validate_schedule_df, validate_schedule_request
 
 logger = logging.getLogger(__name__)
 
+FILE_DATE_FORMAT = "%Y_%m_%d_%H_%M_%S"
 
-def export_schedule_to_sqlitedb(schedule: pd.DataFrame, base_save_path: str):
+
+def get_db_file_name(program_name: str, date: Optional[datetime] = None) -> str:
+    """
+    Function to get the name of a database file
+
+    :param program_name: Name of program
+    :param date: Date to use
+    :return: String of database file name
+    """
+
+    if date is None:
+        date = datetime.now()
+
+    strf_time = date.strftime(FILE_DATE_FORMAT)
+
+    return f"request_{program_name}_{strf_time}.db"
+
+
+def export_schedule_to_sqlitedb(schedule: pd.DataFrame, base_save_path: str) -> Path:
     """
     Function to export a schedule to an sqlite db file
 
@@ -25,17 +45,26 @@ def export_schedule_to_sqlitedb(schedule: pd.DataFrame, base_save_path: str):
     # Validate format of schedule using json schema
     validate_schedule_df(schedule)
 
-    date = datetime.now().strftime("%m_%d_%Y_%H_%s")
+    program_name = str(schedule["progName"].iloc[0])
+
+    schedule_file_name = get_db_file_name(program_name=program_name)
 
-    save_path = f"{base_save_path}timed_requests_{date}.db"
+    save_path = Path(base_save_path).joinpath(schedule_file_name)
 
     logger.info(f"Saving to {save_path}")
 
     sqlite_table = "Summary"
 
+    if not save_path.parent.exists():
+        err = f"Parent directory {save_path.parent} does not exist"
+        logger.error(err)
+        raise ValueError(err)
+
     engine = create_engine(f"sqlite:///{save_path}?check_same_thread=False", echo=True)
     schedule.to_sql(sqlite_table, engine, if_exists="replace", index=False)
 
+    return save_path
+
 
 def submit_schedule(  # pylint: disable=too-many-arguments
     schedule: pd.DataFrame,
@@ -47,7 +76,7 @@ def submit_schedule(  # pylint: disable=too-many-arguments
     program_db_password: str,
     save_path: Optional[str] = None,
     submit_trigger: bool = True,
-):
+) -> Optional[Path]:
     """
     Function to validate, and then optionally submit, a schedule
 
@@ -77,4 +106,6 @@ def submit_schedule(  # pylint: disable=too-many-arguments
             logger.error(err)
             raise ValueError(err)
 
-        export_schedule_to_sqlitedb(schedule, save_path)
+        return export_schedule_to_sqlitedb(schedule, save_path)
+
+    return None

{wintertoo-1.1.0.dist-info → wintertoo-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wintertoo
-Version: 1.1.0
+Version: 1.3.0
 Author-email: Robert Stein <rdstein@caltech.edu>, Danielle Frostig <frostig@mit.edu>, Viraj Karambelkar <viraj@astro.caltech.edu>
 License: MIT
 Project-URL: homepage, https://github.com/winter-telescope/wintertoo

wintertoo-1.3.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+wintertoo/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+wintertoo/database.py,sha256=Ng8qsnDN3p4q-hXRgsHvElzr3k_8H14vq3-C2XChkr8,3020
+wintertoo/errors.py,sha256=iAFcy0z3A3bCnkJmAt_P-77fPaPHFGS1JbrK6O2dCEM,223
+wintertoo/fields.py,sha256=TDSOwJeR4UvfzKQCaIqoPLv0hSU_73TZwQcZ2FbnO8Q,6029
+wintertoo/schedule.py,sha256=Ll_8udFyn14uq3cVri9tVbsz6svluhkX2XXs8JFtLUU,5584
+wintertoo/submit.py,sha256=kd6_aziOf5QcemsyyhSRSnbXlLj8OWsY1_Gj0ZXsUuo,3201
+wintertoo/utils.py,sha256=BWgBZoSX5xfqURb2Nkvf3i6A_IcVYU2SoXFvp6ez7Xc,3306
+wintertoo/validate.py,sha256=YpSABluVXxl33j_ht7TwfC-0SlN4IC0BnbbQiTwUk4c,10476
+wintertoo/data/__init__.py,sha256=7998yomm2Kb0_687D82tjIhqwO-LOh7pru1sNUC1wI0,1594
+wintertoo/data/observing_request_schema.json,sha256=R99sh_XEWVcUEP7eSGtFBw-SMa8M1CQRKfBESdyL9WU,1732
+wintertoo/data/summer_fields.txt,sha256=5Sc7MBUacelzaq1KHSLmfAyZ3WB5YifMNwKRjBRBcRk,52684603
+wintertoo/data/winter_fields.txt,sha256=TxySQTmJXCCgaf-oC1gzOYQb2Vr26KEKdJxqrZHHet0,3529364
+wintertoo/models/__init__.py,sha256=c2GEbIHvOT34IhpiMyqA7Tn83hEmnwx6Q7BuxURp97k,379
+wintertoo/models/image.py,sha256=up4ZnZ4oBkzmIb_8dLCikCWkVgShmv4DhHlhR7u5IS4,3220
+wintertoo/models/program.py,sha256=mtewVnt7NxSK0hxX8aUO8qehEtOi_Cieli4voCCRh4I,1804
+wintertoo/models/too.py,sha256=H9HctFxXL4UPqgjs7Xr8oW0iVLJ8BbLv9oza8HLzBW4,5513
+wintertoo-1.3.0.dist-info/LICENSE,sha256=1-4yY2S7St-8Koy4JGheNG9QPkwff7831u2JITQ2oQs,1063
+wintertoo-1.3.0.dist-info/METADATA,sha256=zKnTl6cA5h5DW740wEisYuT68K5a4Y9z2LKfdfHqHV0,2498
+wintertoo-1.3.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+wintertoo-1.3.0.dist-info/top_level.txt,sha256=6SMjMBzaNrD77erdCiVcRTrPZ-x98SDX43akRjWj4T8,10
+wintertoo-1.3.0.dist-info/RECORD,,

wintertoo-1.1.0.dist-info/RECORD

@@ -1,21 +0,0 @@
-wintertoo/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-wintertoo/database.py,sha256=Ng8qsnDN3p4q-hXRgsHvElzr3k_8H14vq3-C2XChkr8,3020
-wintertoo/errors.py,sha256=iAFcy0z3A3bCnkJmAt_P-77fPaPHFGS1JbrK6O2dCEM,223
-wintertoo/fields.py,sha256=TDSOwJeR4UvfzKQCaIqoPLv0hSU_73TZwQcZ2FbnO8Q,6029
-wintertoo/schedule.py,sha256=eZ7dGwZASXV_94QfZMPrDk0cjAkq17aqLPi7FPa67vs,5476
-wintertoo/submit.py,sha256=TSIx1AFrlNRLC7CCczSHOAwjOBM746sPmeAUUXPVXQ4,2411
-wintertoo/utils.py,sha256=BWgBZoSX5xfqURb2Nkvf3i6A_IcVYU2SoXFvp6ez7Xc,3306
-wintertoo/validate.py,sha256=YpSABluVXxl33j_ht7TwfC-0SlN4IC0BnbbQiTwUk4c,10476
-wintertoo/data/__init__.py,sha256=4wUZ12Y32rGlpoSWo9mky-0MRmgS3alzGf4as6Flfkw,1467
-wintertoo/data/observing_request_schema.json,sha256=D_RnemuUcSSVGe7PVyovcBq-R3B-ckmKNdz9-Zp3bVo,1602
-wintertoo/data/summer_fields.txt,sha256=5Sc7MBUacelzaq1KHSLmfAyZ3WB5YifMNwKRjBRBcRk,52684603
-wintertoo/data/winter_fields.txt,sha256=TxySQTmJXCCgaf-oC1gzOYQb2Vr26KEKdJxqrZHHet0,3529364
-wintertoo/models/__init__.py,sha256=TDWLfOnmRA894TIs3YoRLVtl7FBc8Mb2VlSGzjTSUao,235
-wintertoo/models/image.py,sha256=GmQWydKCZekUCMRiElPuAZo2NpvMoU0jD0N8hAYfn14,2453
-wintertoo/models/program.py,sha256=mtewVnt7NxSK0hxX8aUO8qehEtOi_Cieli4voCCRh4I,1804
-wintertoo/models/too.py,sha256=IosjV8ida1GoT7VddT05ujISFppIF8RHUvwZGBR0FkM,4665
-wintertoo-1.1.0.dist-info/LICENSE,sha256=1-4yY2S7St-8Koy4JGheNG9QPkwff7831u2JITQ2oQs,1063
-wintertoo-1.1.0.dist-info/METADATA,sha256=hoNO6J71dh9L_VhWGdr34hMXylNEP9F0cFNlUhZaT-Y,2498
-wintertoo-1.1.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-wintertoo-1.1.0.dist-info/top_level.txt,sha256=6SMjMBzaNrD77erdCiVcRTrPZ-x98SDX43akRjWj4T8,10
-wintertoo-1.1.0.dist-info/RECORD,,