API

The SPOCK_chilean API reference

Make night blocks

class SPOCK_chilean.make_night_plans.chilean_time(start_date, telescope)[source]

Create and check ACP plans for 10% of SSO’s on-sky-time dedicated to chilean observations

check_distance_speculoos_targets(coords_str, target_name)[source]

check if target is not in SPECULOOS target list

Parameters

  • ra (float) – right ascension (degrees)

  • dec (float) – declinaison (degrees)

  • target_name (str) – name of the target

Returns

state whether there is a SPECULOOS target in the field or not

Return type

info message

check_night_blocks()[source]

Check if plans meet constraints

Returns

return message to inform if the plan are ok or not

Return type

info message

check_plans()[source]

Check if plans meet constraints

Returns

return message to inform if the plan are ok or not

Return type

info message

etc_chilean(Jmag, SpT, Filter)[source]

Return the optimized exposure time for the target

Parameters

  • Jmag (float) – magnitude in J

  • SpT (str) – spectral type of the target

  • Filter (str) – filter used

Returns

texp – exposure time

Return type

float

make_ACP_plans(target_chilean)[source]

Make plans from basic information of each target

Parameters

target_chilean (pd.DataFrame) –

Returns

set of ACP format file required for the observations

Return type

txt files

SPOCK_chilean.make_night_plans.read_night_block(telescope, day)[source]
Parameters

  • telescope (name telescope) –

  • day (date) –

Text files

SPOCK_chilean.txt_files.biasdark(Path)[source]

Write biasdark.txt ACP plan

Parameters

Path (str) – path where the file is stored

Returns

biasdark.txt file

Return type

text file

SPOCK_chilean.txt_files.first_target(name, date_start, date_end, waitlimit, afinterval, autofocus, count, filt, exptime, ra1, ra2, ra3, dec1, dec2, dec3, name_2, Gaia_ID, Path)[source]

Write target_name.txt ACP plan for the first target of the night

Parameters

  • name (str) – name of target

  • date_start (str) – date in “yyyy-mm-dd HH:MM:SS.SSS” format

  • date_end (str) – date in “yyyy-mm-dd HH:MM:SS.SSS” format

  • waitlimit (int) – set to 600 by default

  • afinterval (int) – set to 60 by default

  • autofocus (int) – set to None by default

  • count (int) – number of image for this target, set to 5000 by default

  • filt (str) – filter used

  • exptime (int) – exposure time

  • ra1 (int) – HH in right ascension (HH MM SS.sss format)

  • ra2 (int) – MM in right ascension (HH MM SS.sss format)

  • ra3 (float) – SS.sss in right ascension (HH MM SS.sss format)

  • dec1 (int) – DD in declinaison (DD MM SS.sss format)

  • dec2 (int) – MM in declinaison (DD MM SS.sss format)

  • dec3 (int) – SS.sss in declinaison (DD MM SS.sss format)

  • name_2 (str) – name of the chain plan

  • Gaia_ID (str) – gaia ID of the target

  • Path (str) – path where the plans are stored

Returns

target_name.txt file (ACP compatible)

Return type

txt file

SPOCK_chilean.txt_files.flatdawn(date_end, sun_rise, Path)[source]

Write flatdawn.txt ACP plan

Parameters

  • date_end (str) – time stop of obs in “yyyy-mm-dd HH:MM:SS.SSS” format

  • sun_rise (str) – sun rise time in “yyyy-mm-dd HH:MM:SS.SSS” format

  • Path (str) – path where the file is stored

Returns

flatdawn.txt file

Return type

txt file

SPOCK_chilean.txt_files.flatexo_calli(Path, filt, nbu=None, nbB=None, nbz=None, nbV=None, nbr=None, nbi=None, nbg=None, nbIz=None, nbExo=None, nbClear=None)[source]

Write flatexo.txt ACP plan if the telescope is SSO/Callisto

Parameters

  • Path (str) – path where the file is stored

  • filt (str) – filter used

  • nbu (int) – number of flat needed in u’ filter

  • int (nbClear) – number of flat needed in B filter

  • int – number of flat needed in z’ filter

  • int – number of flat needed in V filter

  • int – number of flat needed in r’ filter

  • int – number of flat needed in i’ filter

  • int – number of flat needed in g’ filter

  • int – number of flat needed in I+z filter

  • int – number of flat needed in Exo filter

  • int – number of flat needed in Clear filter

Returns

flatexo.txt file

Return type

txt file

SPOCK_chilean.txt_files.flatexo_euro(Path, filt, nbRc=None, nbB=None, nbz=None, nbV=None, nbr=None, nbi=None, nbg=None, nbIz=None, nbExo=None, nbClear=None)[source]

Write flatexo.txt ACP plan if the telescope is SSO/Europa

Parameters

  • Path (str) – path where the file is stored

  • filt (str) – filter used

  • nbRc (int) – number of flat needed in Rc filter

  • int (nbClear) – number of flat needed in B filter

  • int – number of flat needed in z’ filter

  • int – number of flat needed in V filter

  • int – number of flat needed in r’ filter

  • int – number of flat needed in i’ filter

  • int – number of flat needed in g’ filter

  • int – number of flat needed in I+z filter

  • int – number of flat needed in Exo filter

  • int – number of flat needed in Clear filter

Returns

flatexo.txt file

Return type

txt file

SPOCK_chilean.txt_files.flatexo_gany(Path, filt, nbOIII=None, nbHa=None, nbSII=None, nbz=None, nbr=None, nbi=None, nbg=None, nbIz=None, nbExo=None, nbClear=None)[source]

Write flatexo.txt ACP plan if the telescope is SSO/Ganymede

Parameters

  • Path (str) – path where the file is stored

  • filt (str) – filter used

  • nbOIII (int) – number of flat needed in OIII filter

  • int (nbClear) – number of flat needed in Ha filter

  • int – number of flat needed in SII filter

  • int – number of flat needed in z’ filter

  • int – number of flat needed in r’ filter

  • int – number of flat needed in i’ filter

  • int – number of flat needed in g’ filter

  • int – number of flat needed in I+z filter

  • int – number of flat needed in Exo filter

  • int – number of flat needed in Clear filter

Returns

flatexo.txt file

Return type

txt file

SPOCK_chilean.txt_files.flatexo_io(Path, filt, nbu=None, nbHa=None, nbRc=None, nbz=None, nbr=None, nbi=None, nbg=None, nbIz=None, nbExo=None, nbClear=None)[source]

Write flatexo.txt ACP plan if the telescope is SSO/io

Parameters

  • Path (str) – path where the file is stored

  • filt (str) – filter used

  • nbu (int) – number of flat needed in u’ filter

  • int (nbClear) – number of flat needed in Ha filter

  • int – number of flat needed in Rc filter

  • int – number of flat needed in z’ filter

  • int – number of flat needed in r’ filter

  • int – number of flat needed in i’ filter

  • int – number of flat needed in g’ filter

  • int – number of flat needed in I+z filter

  • int – number of flat needed in Exo filter

  • int – number of flat needed in Clear filter

Returns

flatexo.txt file

Return type

txt file

SPOCK_chilean.txt_files.shutdown(Path)[source]

Write shutdown.txt ACP plan

Parameters

Path (str) – path where the file is stored

Returns

shutdown.txt file

Return type

text file

SPOCK_chilean.txt_files.startup(name, sun_set, date_start, Path)[source]

Write startup.txt ACP plan

Parameters

  • name (str) – name of the target

  • sun_set (str) – date in “yyyy-mm-dd HH:MM:SS.SSS” format

  • date_start (str) – date in “yyyy-mm-dd HH:MM:SS.SSS” format

  • Path (str) – path where the plans will be stored

Returns

startup.txt file (ACP compatible)

Return type

txt file

SPOCK_chilean.txt_files.target(name, date_start, date_end, waitlimit, afinterval, autofocus, count, filt, exptime, ra1, ra2, ra3, dec1, dec2, dec3, name_2, Gaia_ID, Path)[source]

Write target_name.txt ACP plan

Parameters

  • name (str) – name of target

  • date_start (str) – date in “yyyy-mm-dd HH:MM:SS.SSS” format

  • date_end (str) – date in “yyyy-mm-dd HH:MM:SS.SSS” format

  • waitlimit (int) – set to 600 by default

  • afinterval (int) – set to 60 by default

  • autofocus (int) – set to None by default

  • count (int) – number of image for this target, set to 5000 by default

  • filt (str) – filter used

  • exptime (int) – exposure time

  • ra1 (int) – HH in right ascension (HH MM SS.sss format)

  • ra2 (int) – MM in right ascension (HH MM SS.sss format)

  • ra3 (float) – SS.sss in right ascension (HH MM SS.sss format)

  • dec1 (int) – DD in declinaison (DD MM SS.sss format)

  • dec2 (int) – MM in declinaison (DD MM SS.sss format)

  • dec3 (int) – SS.sss in declinaison (DD MM SS.sss format)

  • name_2 (str) – name of the chain plan

  • Gaia_ID (str) – gaia ID of the target

  • Path (str) – path where the plans are stored

Returns

target_name.txt file (ACP compatible)

Return type

txt file

ETC