Skip to content
Merged

V1.6 #67

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/pylint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ jobs:
pip install --editable ".[dev]"
- name: Analysing the code with pylint
run: |
pylint winterapi --fail-under=10.00
pylint winterapi --fail-under=9.9
2 changes: 2 additions & 0 deletions example.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
WINTER_API_LOCAL="False"
WINTER_API_PROGRAM=
2 changes: 1 addition & 1 deletion notebooks/Example_1_Setting_Up_Credentials.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
}
],
"source": [
"print(f\"Using server {BASE_URL}\") # Should show the URL of the API\n",
"print(f\"Using server {BASE_URL}\") # Should show the URL of the API\n",
"print(f\"Pinging server: {winter.ping()}\")"
]
},
Expand Down
759 changes: 662 additions & 97 deletions notebooks/Example_2_Submitting_a_ToO.ipynb

Large diffs are not rendered by default.

833 changes: 700 additions & 133 deletions notebooks/Example_3_Interacting_with_Observatory_Queue.ipynb

Large diffs are not rendered by default.

81 changes: 68 additions & 13 deletions notebooks/Example_4_Finding_Observatory_Data.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,9 @@
}
],
"source": [
"res, images = winter.query_images_by_program(program_name, image_type=\"exposure\", start_date=start_date, end_date=end_date)"
"res, images = winter.query_images_by_program(\n",
" program_name, image_type=\"exposure\", start_date=start_date, end_date=end_date\n",
")"
]
},
{
Expand Down Expand Up @@ -415,7 +417,13 @@
}
],
"source": [
"res, images = winter.query_images_by_target_name(program_name, image_type=\"exposure\", target_name=target_name, start_date=start_date, end_date=end_date)"
"res, images = winter.query_images_by_target_name(\n",
" program_name,\n",
" image_type=\"exposure\",\n",
" target_name=target_name,\n",
" start_date=start_date,\n",
" end_date=end_date,\n",
")"
]
},
{
Expand Down Expand Up @@ -679,7 +687,14 @@
}
],
"source": [
"res, images = winter.query_images_by_cone(program_name, image_type=\"exposure\", ra_deg=150.959309, dec_deg=17.825813, start_date=start_date, end_date=end_date)"
"res, images = winter.query_images_by_cone(\n",
" program_name,\n",
" image_type=\"exposure\",\n",
" ra_deg=150.959309,\n",
" dec_deg=17.825813,\n",
" start_date=start_date,\n",
" end_date=end_date,\n",
")"
]
},
{
Expand Down Expand Up @@ -950,10 +965,14 @@
],
"source": [
"res, images = winter.query_images_by_rectangle(\n",
" program_name, start_date=start_date, end_date=end_date,\n",
" ra_min_deg = 146., ra_max_deg=147.,\n",
" dec_min_deg = -5., dec_max_deg = -4.,\n",
" image_type=\"stack\"\n",
" program_name,\n",
" start_date=start_date,\n",
" end_date=end_date,\n",
" ra_min_deg=146.0,\n",
" ra_max_deg=147.0,\n",
" dec_min_deg=-5.0,\n",
" dec_max_deg=-4.0,\n",
" image_type=\"stack\",\n",
")"
]
},
Expand Down Expand Up @@ -1302,7 +1321,13 @@
}
],
"source": [
"res, images = winter.query_images_by_target_name(program_name, image_type=\"exposure\", target_name=target_name, start_date=start_date, end_date=end_date)\n",
"res, images = winter.query_images_by_target_name(\n",
" program_name,\n",
" image_type=\"exposure\",\n",
" target_name=target_name,\n",
" start_date=start_date,\n",
" end_date=end_date,\n",
")\n",
"images"
]
},
Expand Down Expand Up @@ -2253,7 +2278,13 @@
}
],
"source": [
"res, images = winter.query_images_by_target_name(program_name, image_type=\"raw\", target_name=target_name, start_date=start_date, end_date=end_date)\n",
"res, images = winter.query_images_by_target_name(\n",
" program_name,\n",
" image_type=\"raw\",\n",
" target_name=target_name,\n",
" start_date=start_date,\n",
" end_date=end_date,\n",
")\n",
"images"
]
},
Expand Down Expand Up @@ -2414,7 +2445,13 @@
}
],
"source": [
"res, images = winter.query_images_by_target_name(program_name, image_type=\"science\", target_name=target_name, start_date=start_date, end_date=end_date)\n",
"res, images = winter.query_images_by_target_name(\n",
" program_name,\n",
" image_type=\"science\",\n",
" target_name=target_name,\n",
" start_date=start_date,\n",
" end_date=end_date,\n",
")\n",
"images"
]
},
Expand Down Expand Up @@ -2520,7 +2557,13 @@
}
],
"source": [
"res, images = winter.query_images_by_target_name(program_name, image_type=\"stack\", target_name=target_name, start_date=start_date, end_date=end_date)\n",
"res, images = winter.query_images_by_target_name(\n",
" program_name,\n",
" image_type=\"stack\",\n",
" target_name=target_name,\n",
" start_date=start_date,\n",
" end_date=end_date,\n",
")\n",
"images"
]
},
Expand Down Expand Up @@ -2625,7 +2668,13 @@
}
],
"source": [
"res, images = winter.query_images_by_target_name(program_name, image_type=\"diff\", target_name=target_name, start_date=start_date, end_date=end_date)\n",
"res, images = winter.query_images_by_target_name(\n",
" program_name,\n",
" image_type=\"diff\",\n",
" target_name=target_name,\n",
" start_date=start_date,\n",
" end_date=end_date,\n",
")\n",
"images"
]
},
Expand Down Expand Up @@ -2732,7 +2781,13 @@
}
],
"source": [
"res, images = winter.query_images_by_target_name(program_name, image_type=\"avro\", target_name=target_name, start_date=start_date, end_date=end_date)\n",
"res, images = winter.query_images_by_target_name(\n",
" program_name,\n",
" image_type=\"avro\",\n",
" target_name=target_name,\n",
" start_date=start_date,\n",
" end_date=end_date,\n",
")\n",
"images"
]
}
Expand Down
8 changes: 6 additions & 2 deletions notebooks/Example_5_Downloading_Observatory_Data.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,9 @@
],
"source": [
"# Let's start by doing an image query\n",
"res, images = winter.query_images_by_program(program_name, image_type=image_type, start_date=\"20240129\")\n",
"res, images = winter.query_images_by_program(\n",
" program_name, image_type=image_type, start_date=\"20240129\"\n",
")\n",
"images"
]
},
Expand Down Expand Up @@ -278,7 +280,9 @@
}
],
"source": [
"res, output_path = winter.download_image_list(program_name, image_type=image_type, paths=savepaths)\n",
"res, output_path = winter.download_image_list(\n",
" program_name, image_type=image_type, paths=savepaths\n",
")\n",
"print(f\"Saved images to {output_path}\")\n",
"print(res.headers)\n",
"res.raise_for_status()"
Expand Down
13 changes: 9 additions & 4 deletions notebooks/Info_2a_ToO_Parameters.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@
"from IPython.display import JSON\n",
"import json\n",
"from winterapi import WinterAPI\n",
"from wintertoo.models import SummerFieldToO, SummerRaDecToO, WinterFieldToO, WinterRaDecToO"
"from wintertoo.models import (\n",
" SummerFieldToO,\n",
" SummerRaDecToO,\n",
" WinterFieldToO,\n",
" WinterRaDecToO,\n",
")"
]
},
{
Expand Down Expand Up @@ -320,7 +325,7 @@
],
"source": [
"# end time in the past\n",
"too = WinterFieldToO(field_id=55, end_time_mjd=58000.)\n",
"too = WinterFieldToO(field_id=55, end_time_mjd=58000.0)\n",
"too"
]
},
Expand Down Expand Up @@ -531,7 +536,7 @@
}
],
"source": [
"too = WinterRaDecToO(ra_deg=300., dec_deg=51.)\n",
"too = WinterRaDecToO(ra_deg=300.0, dec_deg=51.0)\n",
"too"
]
},
Expand Down Expand Up @@ -563,7 +568,7 @@
}
],
"source": [
"too = WinterRaDecToO(ra_deg=300., dec_deg=51., use_field_grid=False)\n",
"too = WinterRaDecToO(ra_deg=300.0, dec_deg=51.0, use_field_grid=False)\n",
"too"
]
},
Expand Down
9 changes: 2 additions & 7 deletions notebooks/Info_2b_Submitting_ToOs.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -333,10 +333,7 @@
}
],
"source": [
"local_schedule = winter.build_schedule_locally(\n",
" program_name=\"202XA000\",\n",
" data=too_list\n",
")\n",
"local_schedule = winter.build_schedule_locally(program_name=\"202XA000\", data=too_list)\n",
"local_schedule"
]
},
Expand All @@ -362,9 +359,7 @@
"outputs": [],
"source": [
"api_res, api_schedule = winter.submit_too(\n",
" program_name=\"202XA000\",\n",
" data=too_list,\n",
" submit_trigger=False\n",
" program_name=\"202XA000\", data=too_list, submit_trigger=False\n",
")"
]
},
Expand Down
11 changes: 6 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "winterapi"
version = "1.5.0"
version = "1.6.0"
description = ""
authors = [
{name = "Robert Stein", email = "rdstein@caltech.edu"}
Expand Down Expand Up @@ -36,13 +36,14 @@ dependencies = [
"jupyter",
"backoff",
"pydantic",
"wintertoo>=1.8.0"
"wintertoo>=1.9.1",
"python-dotenv"
]
[project.optional-dependencies]
dev = [
"black == 24.4.2",
"isort == 5.13.2",
"pylint == 3.2.2",
"black >= 26.1.0",
"isort == 7.0.0",
"pylint == 4.0.4",
"coveralls",
]

Expand Down
14 changes: 7 additions & 7 deletions tests/testdata/test_schedule.csv
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
targName,raDeg,decDeg,fieldID,filter,visitExpTime,singleExpTime,priority,progPI,progName,progID,validStart,validStop,observed,maxAirmass,ditherNumber,ditherStepSize,bestDetector,obsHistID
test_field,211.56398,54.0,3944,Y,300.0,33.333333333333336,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,90.0,True,0
test_field,211.56398,54.0,3944,J,300.0,33.333333333333336,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,90.0,True,1
test_field,211.56398,54.0,3944,Hs,300.0,33.333333333333336,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,90.0,True,2
test_radec,210.910674637,54.3116510708,999999999,Y,300.0,37.5,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,8,90.0,True,3
test_radec,210.910674637,54.3116510708,999999999,J,300.0,37.5,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,8,90.0,True,4
test_radec,210.910674637,54.3116510708,999999999,Hs,300.0,37.5,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,8,90.0,True,5
targName,raDeg,decDeg,fieldID,filter,visitExpTime,singleExpTime,priority,progPI,progName,progID,validStart,validStop,observed,maxAirmass,ditherNumber,ditherStepSize,bestDetector,camera,obsHistID
test_field,211.56398,54.0,3944,Y,300.0,33.333333333333336,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,90.0,True,winter,0
test_field,211.56398,54.0,3944,J,300.0,33.333333333333336,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,90.0,True,winter,1
test_field,211.56398,54.0,3944,Hs,300.0,33.333333333333336,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,90.0,True,winter,2
test_radec,210.910674637,54.3116510708,999999999,Y,300.0,37.5,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,8,90.0,True,winter,3
test_radec,210.910674637,54.3116510708,999999999,J,300.0,37.5,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,8,90.0,True,winter,4
test_radec,210.910674637,54.3116510708,999999999,Hs,300.0,37.5,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,8,90.0,True,winter,5
8 changes: 6 additions & 2 deletions winterapi/base_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,17 @@ def clean_data(data):
if isinstance(data, list):
convert = json.dumps(
[
x.model_dump(exclude=set(x.model_computed_fields.keys()))
x.model_dump(exclude=set(x.__class__.model_computed_fields.keys()))
for x in data
]
)
elif isinstance(data, BaseModel):
convert = json.dumps(
[data.model_dump(exclude=set(data.model_computed_fields.keys()))]
[
data.model_dump(
exclude=set(data.__class__.model_computed_fields.keys())
)
]
)
else:
err = f"Unrecognised data type {type(data)}"
Expand Down
4 changes: 4 additions & 0 deletions winterapi/configure_tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@

import os

from dotenv import load_dotenv

from winterapi import WinterAPI

load_dotenv()

winter = WinterAPI()


Expand Down
5 changes: 5 additions & 0 deletions winterapi/endpoints.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,18 @@

import os

from dotenv import load_dotenv

load_dotenv()

run_local = os.getenv("WINTER_API_LOCAL", "0") in ["True", "true", "1"]
BASE_URL = "http://127.0.0.1:7000" if run_local else "http://winter.caltech.edu:82"
PING_URL = BASE_URL + "/ping"
VERSION_URL = BASE_URL + "/validation/version"
USER_URL = BASE_URL + "/validation/user"
PROGRAM_URL = BASE_URL + "/validation/program"
WINTER_TOO_URL = BASE_URL + "/too/winter"
SPRING_TOO_URL = BASE_URL + "/too/spring"
SUMMER_TOO_URL = BASE_URL + "/too/summer"
SCHEDULE_SUMMARY_URL = BASE_URL + "/too/summary"
SCHEDULE_DETAILS_URL = BASE_URL + "/too/details"
Expand Down
Loading
Loading