Skip to content

Cleaning up README and adding some missing info #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nabeelre wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Cleaning up README and adding some missing info #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83734c8
cleaning up and adding missing content to README
nabeelre Apr 21, 2025
a8c70b0
more cleaning up
nabeelre Apr 21, 2025
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
41 changes: 32 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,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:

Expand All @@ -95,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',
Expand All @@ -112,7 +117,6 @@ payload = {


#example payload for Binospec longslit target payload

payload = {
'objectid':'Targetname',
'ra':'12:34:56.78',
Expand All @@ -125,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,
Expand Down