PyMMT 1.0.0__tar.gz → 1.0.2__tar.gz

{PyMMT-1.0.0 → pymmt-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: PyMMT
-Version: 1.0.0
+Version: 1.0.2
 Summary: A python API wrapper for the MMT Observatory
 Author-email: Samuel Wyatt <swyatt@arizona.edu>, Manisha Shrestha <mshrestha1@arizona.edu>, Griffin Hosseinzadeh <griffin0@arizona.edu>
 Project-URL: Homepage, https://github.com/SAGUARO-MMA/PyMMT
@@ -10,17 +10,22 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
+Requires-Dist: requests
+Requires-Dist: setuptools_scm
+Requires-Dist: ipykernel
 
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8322354.svg)](https://doi.org/10.5281/zenodo.8322354)
 # PyMMT
 
-This repository is designed to facilitate submitting a rapid Target of Opprotunity (ToO) observation to Binospec at the [MMT](https://www.mmto.org/) with the goal to enable same-night spectroscopy of interesting transients. Here we will provide examples to install and upload targets.
+This repository is designed to facilitate rapid Target of Opportunity (ToO) observations to Binospec or MMIRS at the [MMT](https://www.mmto.org/) to enable same-night spectroscopy of interesting transients. Here we will provide examples to install and upload targets.
 
 ## Install
 To get the repository (in a bash/unix terminal)
 ```bash
 git-clone repository
+python -m pip install -e .
+#or
 python -m pip install pymmt
-or pip install pymmt
 ```
 
 ## Using the API Wrapper
@@ -83,12 +88,18 @@ For Binospec `observationtype:longslit`:
   * For `Longslit1_25`: id `131`
   * For `Longslit1_5`: id `114`
   * For `Longslit5`: id `112`
+* `exposuretime`: The observation exposure time in seconds
 
 For MMIRS `observationtype:longslit`:
 * `grism`: Valid options are `J`, `HK`, and `HK3`
+* `filter`: valid options are `Y`, `J`, `H`, `Ks`, `zJ`, `HK`, `HK3`, `Kspec`
 * `readtab`: Valid options are `ramp_4.426`
-* `slitwidth`: valid options are '1pixel', '2pixel', '3pixel', '4pixel', '5pixel','6pixel','12pixel'
+* `slitwidth`: valid options are `1pixel`, `2pixel`, `3pixel`, `4pixel`, `5pixel`, `6pixel`, `12pixel`
 * `slitwidthproperty`: valid options are 'long', 'short'
+* `maskid`: Can be a predefined machined mask, or a preset for imaging or spectroscopy:
+  * For imaging: id `110`
+  * For spectroscopy: id `111`
+* `exposuretime`: The observation exposure time in seconds
 
 Other observation metadata:
 
@@ -106,7 +117,6 @@ All metadata will be validated upon initialization. Once the target object has b
 import pymmt
 
 #example for Binospec imaging target payload:
-
 payload = {
   'objectid':'TARGETNAME',
   'ra':'12:34:56.78',
@@ -123,7 +133,6 @@ payload = {
 
 
 #example payload for Binospec longslit target payload
-
 payload = {
   'objectid':'Targetname',
   'ra':'12:34:56.78',
@@ -136,17 +145,36 @@ payload = {
   `maskid`:131,
   `filter`:'LP380'
   'visits':1,
+  'exposuretime':900,
   'numberexposures':2,
   'priority':1,
   'targetofopportunity':1
 }
-#example payload for MMIRS longslit target payload
 
-payload = {'dec': '-19:30:45.100', 'epoch': 'J2000', 'exposuretime': 450.0,
-        'filter': 'zJ', 'grating': '270','magnitude': 16.9, 'maskid': 111, 'notes': 'Demo observation request. Please do not observe this.',
-        'numberexposures': 3, 'objectid': 'AT2021fxy', 'observationtype': 'longslit','priority': 3, 'ra': '13:13:01.560',
-        'slitwidth': '1pixel', 'targetofopportunity': 0, 'visits': 1,'instrumentid':15, 'gain':'low',
-        'readtab': 'ramp_4.426', 'grism':'J', 'slitwidthproperty':'long', 'dithersize':'5' }
+#example payload for MMIRS longslit target payload
+payload = {
+  'objectid': 'AT2021fxy',
+  'ra': '13:13:01.560',
+  'dec': '-19:30:45.100',
+  'epoch': 'J2000',
+  'exposuretime': 450.0,
+  'filter': 'zJ',
+  'grism': 'J',
+  'magnitude': 16.9,
+  'maskid': 111,
+  'notes': 'Demo observation request. Please do not observe this.',
+  'numberexposures': 3,
+  'observationtype': 'longslit',
+  'priority': 3,
+  'slitwidth': '1pixel',
+  'targetofopportunity': 0,
+  'visits': 1,
+  'instrumentid':15,
+  'gain':'low',
+  'readtab': 'ramp_4.426',
+  'slitwidthproperty':'long',
+  'dithersize':'5'
+  }
 
 #this will create the target along with validating the payload information. It will inform the user of any errors or warnings associated with the metadata
 target = pymmt.Target(token=API_TOKEN, 
@@ -235,14 +263,14 @@ if you don't pass any params into the function it will just find the current ins
 
 ```python
 from datetime import datetime, timedelta
-api = pymmt.api()
-current_instruments = api.get_instruments()
+insts = pymmt.Instruments()
+current_instruments = insts.get_instruments()
 
 #you can look into the future to see what instruments will be available:
-future_instruments = api.get_instruments(date=datetime.datetime.now()+timedelta(months=1))
+future_instruments = insts.get_instruments(date=datetime.datetime.now()+timedelta(months=1))
 
 #you can look through the entire published schedule to see when a certain instrument will be on the telescope (Binospec = 16, MMIRS = 15)
-my_instrument = api.get_instruments(instrumentid=16)
+my_instrument = insts.get_instruments(instrumentid=16)
 ```
 
 This function returns a list of dictionary elements with the values for: 

{PyMMT-1.0.0 → pymmt-1.0.2}/README.md

@@ -1,13 +1,15 @@
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8322354.svg)](https://doi.org/10.5281/zenodo.8322354)
 # PyMMT
 
-This repository is designed to facilitate submitting a rapid Target of Opprotunity (ToO) observation to Binospec at the [MMT](https://www.mmto.org/) with the goal to enable same-night spectroscopy of interesting transients. Here we will provide examples to install and upload targets.
+This repository is designed to facilitate rapid Target of Opportunity (ToO) observations to Binospec or MMIRS at the [MMT](https://www.mmto.org/) to enable same-night spectroscopy of interesting transients. Here we will provide examples to install and upload targets.
 
 ## Install
 To get the repository (in a bash/unix terminal)
 ```bash
 git-clone repository
+python -m pip install -e .
+#or
 python -m pip install pymmt
-or pip install pymmt
 ```
 
 ## Using the API Wrapper
@@ -70,12 +72,18 @@ For Binospec `observationtype:longslit`:
   * For `Longslit1_25`: id `131`
   * For `Longslit1_5`: id `114`
   * For `Longslit5`: id `112`
+* `exposuretime`: The observation exposure time in seconds
 
 For MMIRS `observationtype:longslit`:
 * `grism`: Valid options are `J`, `HK`, and `HK3`
+* `filter`: valid options are `Y`, `J`, `H`, `Ks`, `zJ`, `HK`, `HK3`, `Kspec`
 * `readtab`: Valid options are `ramp_4.426`
-* `slitwidth`: valid options are '1pixel', '2pixel', '3pixel', '4pixel', '5pixel','6pixel','12pixel'
+* `slitwidth`: valid options are `1pixel`, `2pixel`, `3pixel`, `4pixel`, `5pixel`, `6pixel`, `12pixel`
 * `slitwidthproperty`: valid options are 'long', 'short'
+* `maskid`: Can be a predefined machined mask, or a preset for imaging or spectroscopy:
+  * For imaging: id `110`
+  * For spectroscopy: id `111`
+* `exposuretime`: The observation exposure time in seconds
 
 Other observation metadata:
 
@@ -93,7 +101,6 @@ All metadata will be validated upon initialization. Once the target object has b
 import pymmt
 
 #example for Binospec imaging target payload:
-
 payload = {
   'objectid':'TARGETNAME',
   'ra':'12:34:56.78',
@@ -110,7 +117,6 @@ payload = {
 
 
 #example payload for Binospec longslit target payload
-
 payload = {
   'objectid':'Targetname',
   'ra':'12:34:56.78',
@@ -123,17 +129,36 @@ payload = {
   `maskid`:131,
   `filter`:'LP380'
   'visits':1,
+  'exposuretime':900,
   'numberexposures':2,
   'priority':1,
   'targetofopportunity':1
 }
-#example payload for MMIRS longslit target payload
 
-payload = {'dec': '-19:30:45.100', 'epoch': 'J2000', 'exposuretime': 450.0,
-        'filter': 'zJ', 'grating': '270','magnitude': 16.9, 'maskid': 111, 'notes': 'Demo observation request. Please do not observe this.',
-        'numberexposures': 3, 'objectid': 'AT2021fxy', 'observationtype': 'longslit','priority': 3, 'ra': '13:13:01.560',
-        'slitwidth': '1pixel', 'targetofopportunity': 0, 'visits': 1,'instrumentid':15, 'gain':'low',
-        'readtab': 'ramp_4.426', 'grism':'J', 'slitwidthproperty':'long', 'dithersize':'5' }
+#example payload for MMIRS longslit target payload
+payload = {
+  'objectid': 'AT2021fxy',
+  'ra': '13:13:01.560',
+  'dec': '-19:30:45.100',
+  'epoch': 'J2000',
+  'exposuretime': 450.0,
+  'filter': 'zJ',
+  'grism': 'J',
+  'magnitude': 16.9,
+  'maskid': 111,
+  'notes': 'Demo observation request. Please do not observe this.',
+  'numberexposures': 3,
+  'observationtype': 'longslit',
+  'priority': 3,
+  'slitwidth': '1pixel',
+  'targetofopportunity': 0,
+  'visits': 1,
+  'instrumentid':15,
+  'gain':'low',
+  'readtab': 'ramp_4.426',
+  'slitwidthproperty':'long',
+  'dithersize':'5'
+  }
 
 #this will create the target along with validating the payload information. It will inform the user of any errors or warnings associated with the metadata
 target = pymmt.Target(token=API_TOKEN, 
@@ -222,14 +247,14 @@ if you don't pass any params into the function it will just find the current ins
 
 ```python
 from datetime import datetime, timedelta
-api = pymmt.api()
-current_instruments = api.get_instruments()
+insts = pymmt.Instruments()
+current_instruments = insts.get_instruments()
 
 #you can look into the future to see what instruments will be available:
-future_instruments = api.get_instruments(date=datetime.datetime.now()+timedelta(months=1))
+future_instruments = insts.get_instruments(date=datetime.datetime.now()+timedelta(months=1))
 
 #you can look through the entire published schedule to see when a certain instrument will be on the telescope (Binospec = 16, MMIRS = 15)
-my_instrument = api.get_instruments(instrumentid=16)
+my_instrument = insts.get_instruments(instrumentid=16)
 ```
 
 This function returns a list of dictionary elements with the values for: 

{PyMMT-1.0.0 → pymmt-1.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "PyMMT"
-version = "1.0.0"
+version = "1.0.2"
 authors = [
   { name="Samuel Wyatt", email="swyatt@arizona.edu" },
   { name="Manisha Shrestha", email="mshrestha1@arizona.edu" },

{PyMMT-1.0.0 → pymmt-1.0.2}/src/PyMMT.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: PyMMT
-Version: 1.0.0
+Version: 1.0.2
 Summary: A python API wrapper for the MMT Observatory
 Author-email: Samuel Wyatt <swyatt@arizona.edu>, Manisha Shrestha <mshrestha1@arizona.edu>, Griffin Hosseinzadeh <griffin0@arizona.edu>
 Project-URL: Homepage, https://github.com/SAGUARO-MMA/PyMMT
@@ -10,17 +10,22 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
+Requires-Dist: requests
+Requires-Dist: setuptools_scm
+Requires-Dist: ipykernel
 
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8322354.svg)](https://doi.org/10.5281/zenodo.8322354)
 # PyMMT
 
-This repository is designed to facilitate submitting a rapid Target of Opprotunity (ToO) observation to Binospec at the [MMT](https://www.mmto.org/) with the goal to enable same-night spectroscopy of interesting transients. Here we will provide examples to install and upload targets.
+This repository is designed to facilitate rapid Target of Opportunity (ToO) observations to Binospec or MMIRS at the [MMT](https://www.mmto.org/) to enable same-night spectroscopy of interesting transients. Here we will provide examples to install and upload targets.
 
 ## Install
 To get the repository (in a bash/unix terminal)
 ```bash
 git-clone repository
+python -m pip install -e .
+#or
 python -m pip install pymmt
-or pip install pymmt
 ```
 
 ## Using the API Wrapper
@@ -83,12 +88,18 @@ For Binospec `observationtype:longslit`:
   * For `Longslit1_25`: id `131`
   * For `Longslit1_5`: id `114`
   * For `Longslit5`: id `112`
+* `exposuretime`: The observation exposure time in seconds
 
 For MMIRS `observationtype:longslit`:
 * `grism`: Valid options are `J`, `HK`, and `HK3`
+* `filter`: valid options are `Y`, `J`, `H`, `Ks`, `zJ`, `HK`, `HK3`, `Kspec`
 * `readtab`: Valid options are `ramp_4.426`
-* `slitwidth`: valid options are '1pixel', '2pixel', '3pixel', '4pixel', '5pixel','6pixel','12pixel'
+* `slitwidth`: valid options are `1pixel`, `2pixel`, `3pixel`, `4pixel`, `5pixel`, `6pixel`, `12pixel`
 * `slitwidthproperty`: valid options are 'long', 'short'
+* `maskid`: Can be a predefined machined mask, or a preset for imaging or spectroscopy:
+  * For imaging: id `110`
+  * For spectroscopy: id `111`
+* `exposuretime`: The observation exposure time in seconds
 
 Other observation metadata:
 
@@ -106,7 +117,6 @@ All metadata will be validated upon initialization. Once the target object has b
 import pymmt
 
 #example for Binospec imaging target payload:
-
 payload = {
   'objectid':'TARGETNAME',
   'ra':'12:34:56.78',
@@ -123,7 +133,6 @@ payload = {
 
 
 #example payload for Binospec longslit target payload
-
 payload = {
   'objectid':'Targetname',
   'ra':'12:34:56.78',
@@ -136,17 +145,36 @@ payload = {
   `maskid`:131,
   `filter`:'LP380'
   'visits':1,
+  'exposuretime':900,
   'numberexposures':2,
   'priority':1,
   'targetofopportunity':1
 }
-#example payload for MMIRS longslit target payload
 
-payload = {'dec': '-19:30:45.100', 'epoch': 'J2000', 'exposuretime': 450.0,
-        'filter': 'zJ', 'grating': '270','magnitude': 16.9, 'maskid': 111, 'notes': 'Demo observation request. Please do not observe this.',
-        'numberexposures': 3, 'objectid': 'AT2021fxy', 'observationtype': 'longslit','priority': 3, 'ra': '13:13:01.560',
-        'slitwidth': '1pixel', 'targetofopportunity': 0, 'visits': 1,'instrumentid':15, 'gain':'low',
-        'readtab': 'ramp_4.426', 'grism':'J', 'slitwidthproperty':'long', 'dithersize':'5' }
+#example payload for MMIRS longslit target payload
+payload = {
+  'objectid': 'AT2021fxy',
+  'ra': '13:13:01.560',
+  'dec': '-19:30:45.100',
+  'epoch': 'J2000',
+  'exposuretime': 450.0,
+  'filter': 'zJ',
+  'grism': 'J',
+  'magnitude': 16.9,
+  'maskid': 111,
+  'notes': 'Demo observation request. Please do not observe this.',
+  'numberexposures': 3,
+  'observationtype': 'longslit',
+  'priority': 3,
+  'slitwidth': '1pixel',
+  'targetofopportunity': 0,
+  'visits': 1,
+  'instrumentid':15,
+  'gain':'low',
+  'readtab': 'ramp_4.426',
+  'slitwidthproperty':'long',
+  'dithersize':'5'
+  }
 
 #this will create the target along with validating the payload information. It will inform the user of any errors or warnings associated with the metadata
 target = pymmt.Target(token=API_TOKEN, 
@@ -235,14 +263,14 @@ if you don't pass any params into the function it will just find the current ins
 
 ```python
 from datetime import datetime, timedelta
-api = pymmt.api()
-current_instruments = api.get_instruments()
+insts = pymmt.Instruments()
+current_instruments = insts.get_instruments()
 
 #you can look into the future to see what instruments will be available:
-future_instruments = api.get_instruments(date=datetime.datetime.now()+timedelta(months=1))
+future_instruments = insts.get_instruments(date=datetime.datetime.now()+timedelta(months=1))
 
 #you can look through the entire published schedule to see when a certain instrument will be on the telescope (Binospec = 16, MMIRS = 15)
-my_instrument = api.get_instruments(instrumentid=16)
+my_instrument = insts.get_instruments(instrumentid=16)
 ```
 
 This function returns a list of dictionary elements with the values for: 

{PyMMT-1.0.0 → pymmt-1.0.2}/src/PyMMT.egg-info/SOURCES.txt

@@ -9,5 +9,4 @@ src/pymmt/__init__.py
 src/pymmt/pymmt.py
 src/pymmt/instruments/__init__.py
 src/pymmt/instruments/binospec.py
-src/pymmt/instruments/mmirs.py
-tests/test.py
+src/pymmt/instruments/mmirs.py

{PyMMT-1.0.0 → pymmt-1.0.2}/src/pymmt/pymmt.py

@@ -1,16 +1,22 @@
-import os, json, requests, re, time
+import json
+import os
+import re
+import time
+from datetime import datetime
 from pathlib import Path
-from . import MMT_JSON_KEYS, LOCAL_TARGET_KEYS, isInt, isFloat
+
+import requests  # type: ignore
+
+from . import MMT_JSON_KEYS, isFloat, isInt
 from .instruments.binospec import validate as bino_validate
 from .instruments.mmirs import validate as mmirs_validate
-from datetime import datetime
-
 
-class api():
+BASE_URL = "https://scheduler.mmto.arizona.edu/APIv2"
 
-    def __init__(self, target=None, token=None):
+class api:
 
-        self.base = 'https://scheduler.mmto.arizona.edu/APIv2'
+    def __init__(self, base=BASE_URL, target=None, token=None):
+        self.base = base
         self.target = target
 
         if token is None:
@@ -62,7 +68,7 @@ class api():
 
 
 class Target(api):
-    def __init__(self, token=None, verbose=True, payload={}):
+    def __init__(self, token=None, verbose=True, payload={}, base=BASE_URL):
         self.verbose = verbose
         self.valid = False
         self.downloaded = False
@@ -73,7 +79,7 @@ class Target(api):
         }
 
         assert token is not None, 'Token cannot be None'
-        super().__init__('catalogTarget', token)
+        super().__init__(target='catalogTarget', token=token, base=base)
 
         allowed_keys = list(MMT_JSON_KEYS)
         self.__dict__.update((str(key).lower(), value) for key, value in payload.items() if str(key).lower() in allowed_keys)
@@ -94,7 +100,7 @@ class Target(api):
 
         if 'ra' in selfkeys:
             ra = selfdict['ra']
-            r = re.compile('.{2}:.{2}:.{2}\.*')
+            r = re.compile(r'.{2}:.{2}:.{2}\.*')
             if not r.match(ra):
                 errors.append('Invalid format for field \'ra\' ['+ra+']. Valid format is dd:dd:dd.d')
         else:
@@ -102,7 +108,7 @@ class Target(api):
 
         if 'dec' in selfkeys:
             dec = selfdict['dec']
-            r = re.compile('.{2}:.{2}:.{2}\.*')
+            r = re.compile(r'.{2}:.{2}:.{2}\.*')
             isNeg = dec.startswith('-')
             if '-' in dec:
                 dec = dec.split('-')[1]
@@ -460,9 +466,9 @@ class Target(api):
 
 
 class Instruments(api):
-    def __init__(self, token=None, verbose=True, payload={}):
+    def __init__(self, token=None, verbose=True, payload={}, base=BASE_URL):
         self. verbose = verbose
-        super().__init__('trimester//schedule/all/', token)
+        super().__init__(target='trimester//schedule/all/', token=token)
 
     def get_instruments(self, date=None, instrumentid=None, getAll=False):
         if date is None and instrumentid is None:
@@ -505,10 +511,10 @@ class Instruments(api):
 
 
 class Datalist(api):
-    def __init__(self, token=None, verbose=True, payload={}):
+    def __init__(self, token=None, verbose=True, payload={}, base=BASE_URL):
         self.verbose = verbose
         self.data = []
-        super().__init__('data/list/catalogtarget', token)
+        super().__init__(target='data/list/catalogtarget', token=token)
 
 
     def get(self, targetid, data_type='raw'):
@@ -530,9 +536,9 @@ class Datalist(api):
 
 
 class Image(api):
-    def __init__(self, token=None, verbose=True, payload={}):
+    def __init__(self, token=None, verbose=True, payload={}, base=BASE_URL):
         self. verbose = verbose
-        super().__init__('data/download/datafile', token)
+        super().__init__(target='data/download/datafile', token=token)
 
 
     def get(self, datafileid=None, filepath=os.getcwd()):

PyMMT-1.0.0/tests/test.py

@@ -1,33 +0,0 @@
-import os, json, requests
-from requests_toolbelt.multipart.encoder import MultipartEncoder
-
-
-def main():
-
-    token = '0f3732fcfb1c8577c390e71a176f3c8f'
-    catalogid = 486
-    targetid = 6302
-    programid = 977
-    url = 'https://scheduler.mmto.arizona.edu/upload.php'
-    finder = 'M51.jpg'
-
-    multipart_data = MultipartEncoder(
-        fields={
-            'finding_chart_file':(finder, open(finder, 'rb').read(), 'image/jpeg'),
-            'type':'finding_chart',
-            'token':token,
-            'catalog_id':str(catalogid),
-            'program_id':str(programid),
-            'target_id':str(targetid),
-        }
-    )
-
-    headers = {
-        'Content-Type':multipart_data.content_type,
-        'User-Agent':'Mozilla/5.0'
-    }
-
-    r = requests.post(url, headers=headers, data=multipart_data)
-    print(r.text)
-
-main()