wintertoo 0.3.8__py3-none-any.whl → 0.4.2__py3-none-any.whl

wintertoo/data/__init__.py

@@ -19,10 +19,12 @@ 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["Y", "J", "Hs"]
+
+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

wintertoo/data/observing_request_schema.json

@@ -4,7 +4,7 @@
     "obsHistID": {"type": "integer"},
     "raDeg": {"type": "number", "comment": "Degrees (decimal)"},
     "decDeg": {"type": "number", "comment": "Degrees (decimal)"},
-    "filter": {"type": "string", "comment": "'u'/'g'/'r'/'i'/'Y'/'J'/'H'"},
+    "filter": {"type": "string", "comment": "'u'/'g'/'r'/'i'/'Y'/'J'/'H'/'dark'"},
     "visitExpTime": {"type": "number", "comment": "Total observation time (seconds)", "default": 30.0},
     "priority": {"type": "number", "comment": "Priority of observation"},
     "progPI": {"type": "string", "comment": "PI of observation"},
@@ -15,9 +15,9 @@
     "observed": {"anyOf": [{"type":  "boolean", "default":  false}, {"type" : "integer", "minimum" : 0, "maximum" : 1}]},
     "maxAirmass": {"type":  "number", "comment": "Maximum airmass for observation", "default":  2.0},
     "ditherNumber": {"type": "integer", "default": 1},
-    "ditherStepSize": {"type": "number", "comment": "arcsec", "default": 15.0},
+    "ditherStepSize": {"type": "number", "comment": "arcsec", "default": 600.0},
     "fieldID": {"type": "integer", "default": 999999999},
-    "targName": {"type": "string", "comment": "Target name e.g. GW170817"}
+    "targName": {"type": ["string", "null"], "comment": "Target name e.g. GW170817"}
   },
   "required": [
     "obsHistID",

wintertoo/fields.py

@@ -74,10 +74,11 @@ def get_fields_in_box(
     """
 
     field_df = get_fields(summer=summer)
+    base_width = 0.5 * get_base_width(summer=summer)
 
     res = field_df.query(
-        f"(RA > {ra_lim[0]}) and (RA < {ra_lim[1]}) "
-        f"and (Dec > {dec_lim[0]}) and (Dec < {dec_lim[1]})"
+        f"(RA > {ra_lim[0] - base_width}) and (RA < {ra_lim[1] + base_width}) "
+        f"and (Dec > {dec_lim[0] - base_width}) and (Dec < {dec_lim[1] + base_width})"
     )
     return res
 

wintertoo/models/image.py

@@ -5,7 +5,7 @@ from typing import Literal
 
 from astropy import units as u
 from astropy.time import Time
-from pydantic import BaseModel, Field, validator
+from pydantic import BaseModel, Field, FieldValidationInfo, field_validator
 
 from wintertoo.errors import WinterValidationError
 from wintertoo.models import ProgramCredentials
@@ -18,7 +18,7 @@ class BaseImageQuery(BaseModel):
     """
 
     program_list: list[ProgramCredentials] = Field(
-        title="List of programs to search for", min_items=1
+        title="List of programs to search for", min_length=1
     )
     start_date: int = Field(
         title="Start date for images",
@@ -50,24 +50,23 @@ class RectangleImageQuery(BaseImageQuery):
         title="Minimum dec (degrees)", ge=-90.0, le=90.0, default=90.0
     )
 
-    @validator("ra_max", "dec_max")
+    @field_validator("ra_max", "dec_max")
     @classmethod
-    def validate_field_pairs(cls, field_value, values, field):
+    def validate_field_pairs(cls, value: float, info: FieldValidationInfo) -> float:
         """
         Validate that the max value is greater than the min value
 
-        :param field_value: Value of the field
-        :param values: values of all fields
-        :param field: field name
+        :param value: field value
+        :param info: field validation info
         :return: validated field value
         """
-        min_key = field.name.replace("max", "min")
-        min_val = values[min_key]
-        if not field_value > min_val:
+        min_key = info.field_name.replace("max", "min")
+        min_val = info.data[min_key]
+        if not value > min_val:
             raise WinterValidationError(
-                f"{field.name} ({field_value}) not greater than {min_key} ({min_val})"
+                f"{info.field_name} ({value}) not greater than {min_key} ({min_val})"
             )
-        return field_value
+        return value
 
 
 class ConeImageQuery(BaseImageQuery):

wintertoo/models/program.py

@@ -5,8 +5,9 @@ Duplicated (sorry) from mirar/pipelines/summer/models/program.py, to avoid
 an elaborate web of imports for WSP.
 """
 from datetime import date
+from typing import Optional
 
-from pydantic import BaseModel, Extra, Field, validator
+from pydantic import BaseModel, ConfigDict, Field, FieldValidationInfo, field_validator
 
 
 class ProgramCredentials(BaseModel):
@@ -23,7 +24,7 @@ class Program(ProgramCredentials):
     A pydantic model for a program database entry
     """
 
-    puid: int = Field(default=None)
+    puid: Optional[int] = Field(default=None)
     progid: int = Field(default=1)
     pi_name: str = Field(min_length=1, example="Hubble", default=None)
     pi_email: str = Field(min_length=1, example="someone@institute.com", default=None)
@@ -34,31 +35,35 @@ class Program(ProgramCredentials):
     maxpriority: float = Field(description="Max priority")
     progtitle: str = Field(min_length=1, example="A program title", default=None)
 
-    @validator("enddate")
+    @field_validator("enddate")
     @classmethod
-    def check_date(cls, field_value, values):
+    def check_date(cls, enddate: date, info: FieldValidationInfo) -> date:
         """
         Ensure dates are correctly formatted
 
+        :param enddate: end date
+        :param info: field validation info
+        :return: end date
         """
-        startdate = values["startdate"]
-        assert field_value > startdate
-        return field_value
+        startdate = info.data["startdate"]
+        assert enddate > startdate
+        return enddate
 
-    @validator("hours_remaining")
+    @field_validator("hours_remaining")
     @classmethod
-    def validate_time_allocation(cls, field_value, values):
+    def validate_time_allocation(
+        cls, hours_remaining: float, info: FieldValidationInfo
+    ) -> float:
         """
         Ensure that time remaining has a sensible value
 
-        :param field_value: field value
-        :param values: values
+        :param hours_remaining: hours remaining
+        :param info: field validation info
         :return: field value
         """
-        total_time = values["hours_allocated"]
-        assert not field_value > total_time
-        assert not field_value < 0.0
-        return field_value
+        total_time = info.data["hours_allocated"]
+        assert not hours_remaining > total_time
+        assert not hours_remaining < 0.0
+        return hours_remaining
 
-    class Config:  # pylint: disable=missing-class-docstring,too-few-public-methods
-        extra = Extra.forbid
+    model_config = ConfigDict(extra="forbid")

wintertoo/models/too.py

@@ -4,17 +4,27 @@ Models for ToO requests
 from typing import List, Optional, Union
 
 from astropy.time import Time
-from pydantic import BaseModel, Extra, Field, validator
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    FieldValidationInfo,
+    field_validator,
+    model_validator,
+)
 
 from wintertoo.data import (
     SUMMER_FILTERS,
-    WINTER_FILTERS,
+    WINTER_SCIENCE_FILTERS,
     SummerFilters,
     WinterFilters,
     get_default_value,
 )
 from wintertoo.errors import WinterValidationError
 
+MIN_EXPOSURE_TIME = 0.28
+MAX_EXPOSURE_TIME = 300.0
+
 
 class ToORequest(BaseModel):
     """
@@ -29,9 +39,8 @@ class ToORequest(BaseModel):
     )
     t_exp: float = Field(
         default=get_default_value("visitExpTime"),
-        title="Individual exposure time (s)",
+        title="Combined Exposure Time across dithers (s)",
         ge=1.0,
-        le=300,
     )
     n_exp: int = Field(default=1, ge=1, title="Number of dither sets")
     n_dither: int = Field(
@@ -54,28 +63,54 @@ class ToORequest(BaseModel):
         title="Allowed airmass range",
     )
 
-    @validator("end_time_mjd")
+    @field_validator("end_time_mjd")
     @classmethod
-    def validate_field_pairs(cls, field_value, values, field):
+    def validate_field_pairs(
+        cls, end_time_mjd: float, info: FieldValidationInfo
+    ) -> float:
         """
         Field validator to ensure that the end time is greater than the start time
 
-        :param field_value: value of the field
-        :param values: values of all fields
-        :param field: field name
+        :param end_time_mjd: field value
+        :param info: field validation info
         :return: validated field value
         """
-        min_key = "start_time_mjd"
-        start_time = values[min_key]
-        if not field_value > start_time:
+        start_time = info.data["start_time_mjd"]
+        if not end_time_mjd > start_time:
             raise WinterValidationError(
-                f"{field.name} ({field_value}) not "
-                f"greater than {min_key} ({start_time})"
+                f"end_time_mjd ({end_time_mjd}) not "
+                f"greater than start_time_mjd ({start_time})"
             )
-        return field_value
+        return end_time_mjd
+
+    @model_validator(mode="after")
+    def validate_t_exp(self):
+        """
+        Field validator to ensure that the exposure time is not too long
+
+        :return: Validated total exposure time per dither set
+        """
+        n_dithers = self.n_dither
+        t_exp = self.t_exp
+        t_per_dither = t_exp / n_dithers
+
+        if t_per_dither > MAX_EXPOSURE_TIME:
+            raise WinterValidationError(
+                f"t_exp ({t_exp}) is too long for {n_dithers} dithers. "
+                f"Max exposure time per dither is {MAX_EXPOSURE_TIME} s, "
+                f"while you have selected {t_per_dither} s per dither"
+            )
+
+        if t_per_dither < MIN_EXPOSURE_TIME:
+            raise WinterValidationError(
+                f"t_exp ({t_exp}) is too short for {n_dithers} dithers. "
+                f"Min exposure time per dither is {MIN_EXPOSURE_TIME} s, "
+                f"while you have selected {t_per_dither} s per dither"
+            )
+
+        return self
 
-    class Config:  # pylint: disable=missing-class-docstring,too-few-public-methods
-        extra = Extra.forbid
+    model_config = ConfigDict(extra="forbid")
 
 
 class ObsWithRaDec(BaseModel):
@@ -124,7 +159,7 @@ class Summer(ToORequest):
 class Winter(ToORequest):
     """Winter ToO Request"""
 
-    filters: list[WinterFilters] = WINTER_FILTERS
+    filters: list[WinterFilters] = WINTER_SCIENCE_FILTERS
 
 
 class SummerFieldToO(Summer, FieldToO):

wintertoo/schedule.py

@@ -79,7 +79,7 @@ def build_schedule_list(
     too: FullTooRequest,
     program: Program,
     csv_save_file: str = None,
-):
+) -> pd.DataFrame:
     """
     Generate a full schedule request for single target,
     with all of RA, Dec and Field ID provided
@@ -118,7 +118,7 @@ def schedule_ra_dec(
     else:
         field_id = get_default_value("fieldID")
 
-    full_request = FullTooRequest(field_id=field_id, **too.dict())
+    full_request = FullTooRequest(field_id=field_id, **too.model_dump())
 
     schedule = make_schedule(
         toos=[full_request],
@@ -149,7 +149,7 @@ def schedule_field(
     ra_deg = float(field_details["RA"].iloc[0])
     dec_deg = float(field_details["Dec"].iloc[0])
 
-    full_request = FullTooRequest(ra_deg=ra_deg, dec_deg=dec_deg, **too.dict())
+    full_request = FullTooRequest(ra_deg=ra_deg, dec_deg=dec_deg, **too.model_dump())
 
     schedule = make_schedule(
         toos=[full_request],
@@ -185,7 +185,7 @@ def concat_toos(
                 program=program,
             )
         else:
-            err = f"Unrecognised type {type(too)}"
+            err = f"Unrecognised type {type(too)} for {too}"
             logger.error(err)
             raise WinterValidationError(err)
 

{wintertoo-0.3.8.dist-info → wintertoo-0.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wintertoo
-Version: 0.3.8
+Version: 0.4.2
 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
@@ -21,7 +21,7 @@ Classifier: Operating System :: MacOS
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pandas (>=2.0.0)
+Requires-Dist: pandas
 Requires-Dist: astropy
 Requires-Dist: astroplan
 Requires-Dist: matplotlib
@@ -29,15 +29,15 @@ Requires-Dist: numpy
 Requires-Dist: pytz
 Requires-Dist: jsonschema
 Requires-Dist: sqlalchemy
-Requires-Dist: pydantic
+Requires-Dist: pydantic >=2.2.0
 Requires-Dist: pre-commit
 Requires-Dist: bcrypt
 Requires-Dist: psycopg
 Requires-Dist: psycopg-binary
 Provides-Extra: dev
-Requires-Dist: black (==23.3.0) ; extra == 'dev'
-Requires-Dist: isort (==5.12.0) ; extra == 'dev'
-Requires-Dist: pylint (==2.17.4) ; extra == 'dev'
+Requires-Dist: black ==23.7.0 ; extra == 'dev'
+Requires-Dist: isort ==5.12.0 ; extra == 'dev'
+Requires-Dist: pylint ==2.17.5 ; extra == 'dev'
 Requires-Dist: coveralls ; extra == 'dev'
 
 # wintertoo
@@ -63,4 +63,5 @@ pip install wintertoo
 git clone git@github.com:winter-telescope/wintertoo.git
 cd wintertoo
 pip install --editable ".[dev]"
+pre-commit install
 ```

wintertoo-0.4.2.dist-info/RECORD

@@ -0,0 +1,21 @@
+wintertoo/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+wintertoo/database.py,sha256=I-GP76aNmO1KDNbiEdpqsbHLVvTE791QwOqab6I_BHc,3019
+wintertoo/errors.py,sha256=iAFcy0z3A3bCnkJmAt_P-77fPaPHFGS1JbrK6O2dCEM,223
+wintertoo/fields.py,sha256=xxQs-dZeBeiqemOoTtL0iihyLwzDfrRS8Dqc9N73BfI,6028
+wintertoo/schedule.py,sha256=jr6pOuA89Tlonm8bM0QinoHzGtHVgRLMv2z9TZdEF3c,5475
+wintertoo/submit.py,sha256=0Ok3EiwSMB26Wp8c3Y3xfhd2MRWrWCuNpHTxwu8MbcM,2410
+wintertoo/utils.py,sha256=BWgBZoSX5xfqURb2Nkvf3i6A_IcVYU2SoXFvp6ez7Xc,3306
+wintertoo/validate.py,sha256=R8GwP8DmDTSeDGEGZ16yW_2jgZqGNxcSqjLFw0f8O9E,8963
+wintertoo/data/__init__.py,sha256=XMHBEWA9_fioEFIbYZASV1t90JFi1gIAfNKyCRk2x54,1466
+wintertoo/data/observing_request_schema.json,sha256=A79t4FzTeZQgK3kA_087LT2xpS7EaDcjkKtNUqAWoog,1603
+wintertoo/data/summer_fields.txt,sha256=5Sc7MBUacelzaq1KHSLmfAyZ3WB5YifMNwKRjBRBcRk,52684603
+wintertoo/data/winter_fields.txt,sha256=TxySQTmJXCCgaf-oC1gzOYQb2Vr26KEKdJxqrZHHet0,3529364
+wintertoo/models/__init__.py,sha256=ZE3R3rCgijStd36IEs620NRP9R18Ay2CvYUZyJQvreA,234
+wintertoo/models/image.py,sha256=l0gsXM68AvN5NkD1JGMbFZkLz2Qx4EjzSL9Z3YjoOes,2484
+wintertoo/models/program.py,sha256=D3UyzkedmX5L5eM3wGY398GXf3v2g27b0FlHpnRCNhc,2145
+wintertoo/models/too.py,sha256=ZQyX2ak2-EeUa_S6nEg6EZrjt6h4l5EtmZFVvmkxUOM,4885
+wintertoo-0.4.2.dist-info/LICENSE,sha256=1-4yY2S7St-8Koy4JGheNG9QPkwff7831u2JITQ2oQs,1063
+wintertoo-0.4.2.dist-info/METADATA,sha256=5qjocQ4uiVn3gllBbaab1TSkSciPGGXRtEq6N25gnH0,2499
+wintertoo-0.4.2.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+wintertoo-0.4.2.dist-info/top_level.txt,sha256=6SMjMBzaNrD77erdCiVcRTrPZ-x98SDX43akRjWj4T8,10
+wintertoo-0.4.2.dist-info/RECORD,,

{wintertoo-0.3.8.dist-info → wintertoo-0.4.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.40.0)
+Generator: bdist_wheel (0.41.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

wintertoo-0.3.8.dist-info/RECORD

@@ -1,21 +0,0 @@
-wintertoo/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-wintertoo/database.py,sha256=I-GP76aNmO1KDNbiEdpqsbHLVvTE791QwOqab6I_BHc,3019
-wintertoo/errors.py,sha256=iAFcy0z3A3bCnkJmAt_P-77fPaPHFGS1JbrK6O2dCEM,223
-wintertoo/fields.py,sha256=AX21FB0-qolcpsRYkIywd16CeX8W023Qq5g3rLmfVEo,5923
-wintertoo/schedule.py,sha256=_v1JMrMYzkgiX5YcnoGoCuCEYlPQh-RdNim1REHWE00,5437
-wintertoo/submit.py,sha256=0Ok3EiwSMB26Wp8c3Y3xfhd2MRWrWCuNpHTxwu8MbcM,2410
-wintertoo/utils.py,sha256=BWgBZoSX5xfqURb2Nkvf3i6A_IcVYU2SoXFvp6ez7Xc,3306
-wintertoo/validate.py,sha256=R8GwP8DmDTSeDGEGZ16yW_2jgZqGNxcSqjLFw0f8O9E,8963
-wintertoo/data/__init__.py,sha256=vVltDgj2leaWF1Awl4ohZqZzCr_OIZDccVx_2ZWSgfI,1415
-wintertoo/data/observing_request_schema.json,sha256=jGRpCT9GYAQr-V0IB1V4_noXvXSxN1fnz6p0fVb8l2s,1585
-wintertoo/data/summer_fields.txt,sha256=5Sc7MBUacelzaq1KHSLmfAyZ3WB5YifMNwKRjBRBcRk,52684603
-wintertoo/data/winter_fields.txt,sha256=TxySQTmJXCCgaf-oC1gzOYQb2Vr26KEKdJxqrZHHet0,3529364
-wintertoo/models/__init__.py,sha256=ZE3R3rCgijStd36IEs620NRP9R18Ay2CvYUZyJQvreA,234
-wintertoo/models/image.py,sha256=XJmS0HryoeS6YFU9zpI5QPEKh1tC_iIVmsq8638sNlc,2480
-wintertoo/models/program.py,sha256=VR5F7XfRVVkNp_ztxBTLQCDemTtpKIdefTxPu6gy7LQ,1915
-wintertoo/models/too.py,sha256=dAK4mT7j3cbO75uo0Z03e0uL78KFLPLVANQFaGExG6o,3825
-wintertoo-0.3.8.dist-info/LICENSE,sha256=1-4yY2S7St-8Koy4JGheNG9QPkwff7831u2JITQ2oQs,1063
-wintertoo-0.3.8.dist-info/METADATA,sha256=DxP4BCw21irMXeMLzqwP5ySfE1fc6h3DO2Y0EGI7_vc,2488
-wintertoo-0.3.8.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-wintertoo-0.3.8.dist-info/top_level.txt,sha256=6SMjMBzaNrD77erdCiVcRTrPZ-x98SDX43akRjWj4T8,10
-wintertoo-0.3.8.dist-info/RECORD,,