{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Useful tools"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 1- Transit observability predictions"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "In this section we present a tool to predict whether the next transits of your favorite exoplanet will be observable from ome of the SPECULOOS site"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Only a few basic information are needed:\n",
    "\n",
    "* Site name, ex: `obs_name = 'SSO'`\n",
    "\n",
    "* Planet name, ex: `name = TRAPPIST-1b`\n",
    "\n",
    "* Right ascension, ex: `ra = 346.622384`  \n",
    "\n",
    "* Declinaison, ex: `dec = -5.041398`\n",
    "\n",
    "* Timing (in BJD_TDB), ex: `timing = 2457322.51505`\n",
    "\n",
    "* Period (in days), ex: `period = 1.51088212`\n",
    "\n",
    "* Transit duration (in days), ex: `duration = 0.02511108`\n",
    "\n",
    "* Date to start prediction, ex start_date = `'2020-06-01 00:00:00'`\n",
    "\n",
    "* Number of next transits from this atart date, ex: `ntr = 4`\n",
    "\n",
    "\n",
    "Note that this tools is not suposed to be very precise as errors on timing, period and duration are **NOT** taken into account. "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>Ingress</th>\n",
       "      <th>Egress</th>\n",
       "      <th>mid transit</th>\n",
       "      <th>mid transit JD</th>\n",
       "      <th>Observable SSO</th>\n",
       "      <th>Observable SNO</th>\n",
       "      <th>Observable Saint-Ex</th>\n",
       "      <th>Observable TN Oukaimeden</th>\n",
       "      <th>Observable TS La Silla</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>TRAPPIST-1b</th>\n",
       "      <td>2020-10-02 11:38:11.217</td>\n",
       "      <td>2020-10-02 12:14:20.814</td>\n",
       "      <td>2020-10-02 11:56:16.015</td>\n",
       "      <td>2459124.997</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>TRAPPIST-1b</th>\n",
       "      <td>2020-10-03 23:53:51.432</td>\n",
       "      <td>2020-10-04 00:30:01.029</td>\n",
       "      <td>2020-10-04 00:11:56.231</td>\n",
       "      <td>2459126.508</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>TRAPPIST-1b</th>\n",
       "      <td>2020-10-05 12:09:31.647</td>\n",
       "      <td>2020-10-05 12:45:41.244</td>\n",
       "      <td>2020-10-05 12:27:36.446</td>\n",
       "      <td>2459128.019</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>TRAPPIST-1b</th>\n",
       "      <td>2020-10-07 00:25:11.862</td>\n",
       "      <td>2020-10-07 01:01:21.460</td>\n",
       "      <td>2020-10-07 00:43:16.661</td>\n",
       "      <td>2459129.530</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "                             Ingress                   Egress  \\\n",
       "TRAPPIST-1b  2020-10-02 11:38:11.217  2020-10-02 12:14:20.814   \n",
       "TRAPPIST-1b  2020-10-03 23:53:51.432  2020-10-04 00:30:01.029   \n",
       "TRAPPIST-1b  2020-10-05 12:09:31.647  2020-10-05 12:45:41.244   \n",
       "TRAPPIST-1b  2020-10-07 00:25:11.862  2020-10-07 01:01:21.460   \n",
       "\n",
       "                         mid transit  mid transit JD  Observable SSO  \\\n",
       "TRAPPIST-1b  2020-10-02 11:56:16.015     2459124.997           False   \n",
       "TRAPPIST-1b  2020-10-04 00:11:56.231     2459126.508            True   \n",
       "TRAPPIST-1b  2020-10-05 12:27:36.446     2459128.019           False   \n",
       "TRAPPIST-1b  2020-10-07 00:43:16.661     2459129.530            True   \n",
       "\n",
       "             Observable SNO  Observable Saint-Ex  Observable TN Oukaimeden  \\\n",
       "TRAPPIST-1b           False                False                     False   \n",
       "TRAPPIST-1b            True                False                      True   \n",
       "TRAPPIST-1b           False                False                     False   \n",
       "TRAPPIST-1b            True                False                      True   \n",
       "\n",
       "             Observable TS La Silla  \n",
       "TRAPPIST-1b                   False  \n",
       "TRAPPIST-1b                    True  \n",
       "TRAPPIST-1b                   False  \n",
       "TRAPPIST-1b                    True  "
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "import SPOCK.short_term_scheduler as SPOCKST\n",
    "\n",
    "SPOCKST.prediction(name='TRAPPIST-1b',ra=346.,dec=-5.05,\n",
    "                   timing=2457322.51505,\n",
    "                   period=1.51088212,duration=0.02511108,\n",
    "                   start_date='2020-10-01 00:00:00',ntr=4)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 2- Get info on a target from SPECULOOS target list"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "If you want to check rapidly the stellar properties, GAIA ID, its priority, its completion etc of a SPECULOOS `target`, you can use the following function:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>Sp_ID</th>\n",
       "      <th>2MASS</th>\n",
       "      <th>Gaia_ID</th>\n",
       "      <th>wise</th>\n",
       "      <th>Program</th>\n",
       "      <th>nb_hours_surved</th>\n",
       "      <th>nb_hours_threshold</th>\n",
       "      <th>RA</th>\n",
       "      <th>DEC</th>\n",
       "      <th>e_gra</th>\n",
       "      <th>e_gdec</th>\n",
       "      <th>telescope</th>\n",
       "      <th>Filter_spc</th>\n",
       "      <th>texp_spc</th>\n",
       "      <th>Filter_trap</th>\n",
       "      <th>texp_trap</th>\n",
       "      <th>dist</th>\n",
       "      <th>dist_err</th>\n",
       "      <th>SpT</th>\n",
       "      <th>e_SpT</th>\n",
       "      <th>Ms</th>\n",
       "      <th>e_Ms</th>\n",
       "      <th>Rs</th>\n",
       "      <th>e_Rs</th>\n",
       "      <th>T_eff</th>\n",
       "      <th>...</th>\n",
       "      <th>mag_rp</th>\n",
       "      <th>mag_rp_err</th>\n",
       "      <th>Habs</th>\n",
       "      <th>e_Habs</th>\n",
       "      <th>Jabs</th>\n",
       "      <th>e_Jabs</th>\n",
       "      <th>Kabs</th>\n",
       "      <th>e_Kabs</th>\n",
       "      <th>Gabs</th>\n",
       "      <th>e_Gabs</th>\n",
       "      <th>BCj</th>\n",
       "      <th>BCj_err</th>\n",
       "      <th>L_bol</th>\n",
       "      <th>L_bol_err</th>\n",
       "      <th>cf</th>\n",
       "      <th>num_stars</th>\n",
       "      <th>min_dist_stars</th>\n",
       "      <th>avg_dist_stars</th>\n",
       "      <th>rel_flux_stars</th>\n",
       "      <th>plx</th>\n",
       "      <th>plx_err</th>\n",
       "      <th>pmra</th>\n",
       "      <th>pmdec</th>\n",
       "      <th>pmra_err</th>\n",
       "      <th>pmdec_err</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>334</th>\n",
       "      <td>Sp0439-3235</td>\n",
       "      <td>04393407-3235516</td>\n",
       "      <td>4.871414e+18</td>\n",
       "      <td>J043933.97-323551.4</td>\n",
       "      <td>1.0</td>\n",
       "      <td>228.16</td>\n",
       "      <td>200.0</td>\n",
       "      <td>69.891853</td>\n",
       "      <td>-32.597658</td>\n",
       "      <td>0.056772</td>\n",
       "      <td>0.06425</td>\n",
       "      <td>['Callisto']</td>\n",
       "      <td>I+z</td>\n",
       "      <td>0.0</td>\n",
       "      <td>I+z</td>\n",
       "      <td>0.0</td>\n",
       "      <td>20.2</td>\n",
       "      <td>0.0</td>\n",
       "      <td>5.4</td>\n",
       "      <td>0.9</td>\n",
       "      <td>0.113</td>\n",
       "      <td>0.001</td>\n",
       "      <td>0.138</td>\n",
       "      <td>0.02</td>\n",
       "      <td>2925.0</td>\n",
       "      <td>...</td>\n",
       "      <td>13.910709</td>\n",
       "      <td>0.003683</td>\n",
       "      <td>9.486847</td>\n",
       "      <td>0.025223</td>\n",
       "      <td>10.086847</td>\n",
       "      <td>0.022253</td>\n",
       "      <td>9.106847</td>\n",
       "      <td>0.025223</td>\n",
       "      <td>13.829693</td>\n",
       "      <td>0.003464</td>\n",
       "      <td>1.912446</td>\n",
       "      <td>0.029292</td>\n",
       "      <td>0.001248</td>\n",
       "      <td>0.000042</td>\n",
       "      <td>0.0</td>\n",
       "      <td>1.0</td>\n",
       "      <td>44.57</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "      <td>-101.527</td>\n",
       "      <td>9.711</td>\n",
       "      <td>0.124</td>\n",
       "      <td>0.145</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>1 rows × 72 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "           Sp_ID             2MASS       Gaia_ID                 wise  \\\n",
       "334  Sp0439-3235  04393407-3235516  4.871414e+18  J043933.97-323551.4   \n",
       "\n",
       "     Program  nb_hours_surved  nb_hours_threshold         RA        DEC  \\\n",
       "334      1.0           228.16               200.0  69.891853 -32.597658   \n",
       "\n",
       "        e_gra   e_gdec     telescope Filter_spc  texp_spc Filter_trap  \\\n",
       "334  0.056772  0.06425  ['Callisto']        I+z       0.0         I+z   \n",
       "\n",
       "     texp_trap  dist  dist_err  SpT  e_SpT     Ms   e_Ms     Rs  e_Rs   T_eff  \\\n",
       "334        0.0  20.2       0.0  5.4    0.9  0.113  0.001  0.138  0.02  2925.0   \n",
       "\n",
       "     ...     mag_rp  mag_rp_err      Habs    e_Habs       Jabs    e_Jabs  \\\n",
       "334  ...  13.910709    0.003683  9.486847  0.025223  10.086847  0.022253   \n",
       "\n",
       "         Kabs    e_Kabs       Gabs    e_Gabs       BCj   BCj_err     L_bol  \\\n",
       "334  9.106847  0.025223  13.829693  0.003464  1.912446  0.029292  0.001248   \n",
       "\n",
       "    L_bol_err   cf  num_stars  min_dist_stars  avg_dist_stars rel_flux_stars  \\\n",
       "334  0.000042  0.0        1.0           44.57             0.0            0.0   \n",
       "\n",
       "     plx  plx_err     pmra  pmdec  pmra_err  pmdec_err  \n",
       "334  0.0      0.0 -101.527  9.711     0.124      0.145  \n",
       "\n",
       "[1 rows x 72 columns]"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "import SPOCK.stats as SPOCKstats\n",
    "\n",
    "SPOCKstats.info_on_Sp_target(target = 'Sp0439-3235')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 3- Get info on scheduled night blocks"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Here we propose a function to check which targets have been scheduled on the SPECULOOS telescopes by displaying its corresponding <span style=\"background-color:lightyellow\"><font color='orangered'> **night_blocks** </font></span>. The user will onyly have to precise the `date` and the `telescope`."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>target</th>\n",
       "      <th>start time (UTC)</th>\n",
       "      <th>end time (UTC)</th>\n",
       "      <th>duration (minutes)</th>\n",
       "      <th>ra (h)</th>\n",
       "      <th>ra (m)</th>\n",
       "      <th>ra (s)</th>\n",
       "      <th>dec (d)</th>\n",
       "      <th>dec (m)</th>\n",
       "      <th>dec (s)</th>\n",
       "      <th>configuration</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>Sp2330-4736</td>\n",
       "      <td>2020-10-12 23:36:20.018</td>\n",
       "      <td>2020-10-12 23:31:00.021</td>\n",
       "      <td>56.666717</td>\n",
       "      <td>23.0</td>\n",
       "      <td>30.0</td>\n",
       "      <td>15.887304</td>\n",
       "      <td>-47.0</td>\n",
       "      <td>-36.0</td>\n",
       "      <td>-45.08424</td>\n",
       "      <td>{'filt=I+z', 'texp=15'}</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>Trappist-1b</td>\n",
       "      <td>2020-10-12 23:31:00.021</td>\n",
       "      <td>2020-10-13 02:59:20.021</td>\n",
       "      <td>146.333333</td>\n",
       "      <td>23.0</td>\n",
       "      <td>6.0</td>\n",
       "      <td>29.000000</td>\n",
       "      <td>-5.0</td>\n",
       "      <td>-2.0</td>\n",
       "      <td>-28.00000</td>\n",
       "      <td>{'filt=I+z', 'texp=23'}</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>Sp2330-4736_2</td>\n",
       "      <td>2020-10-13 02:59:20.021</td>\n",
       "      <td>2020-10-13 04:23:20.018</td>\n",
       "      <td>83.999950</td>\n",
       "      <td>23.0</td>\n",
       "      <td>30.0</td>\n",
       "      <td>15.887304</td>\n",
       "      <td>-47.0</td>\n",
       "      <td>-36.0</td>\n",
       "      <td>-45.08424</td>\n",
       "      <td>{'filt=I+z', 'texp=15'}</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>Sp0553-7133</td>\n",
       "      <td>2020-10-13 04:24:20.028</td>\n",
       "      <td>2020-10-13 09:19:20.028</td>\n",
       "      <td>56.666717</td>\n",
       "      <td>5.0</td>\n",
       "      <td>53.0</td>\n",
       "      <td>26.479968</td>\n",
       "      <td>-71.0</td>\n",
       "      <td>-33.0</td>\n",
       "      <td>-49.79088</td>\n",
       "      <td>{'filt=i', 'texp=16'}</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "          target         start time (UTC)           end time (UTC)  \\\n",
       "0    Sp2330-4736  2020-10-12 23:36:20.018  2020-10-12 23:31:00.021   \n",
       "1    Trappist-1b  2020-10-12 23:31:00.021  2020-10-13 02:59:20.021   \n",
       "2  Sp2330-4736_2  2020-10-13 02:59:20.021  2020-10-13 04:23:20.018   \n",
       "3    Sp0553-7133  2020-10-13 04:24:20.028  2020-10-13 09:19:20.028   \n",
       "\n",
       "   duration (minutes)  ra (h)  ra (m)     ra (s)  dec (d)  dec (m)   dec (s)  \\\n",
       "0           56.666717    23.0    30.0  15.887304    -47.0    -36.0 -45.08424   \n",
       "1          146.333333    23.0     6.0  29.000000     -5.0     -2.0 -28.00000   \n",
       "2           83.999950    23.0    30.0  15.887304    -47.0    -36.0 -45.08424   \n",
       "3           56.666717     5.0    53.0  26.479968    -71.0    -33.0 -49.79088   \n",
       "\n",
       "             configuration  \n",
       "0  {'filt=I+z', 'texp=15'}  \n",
       "1  {'filt=I+z', 'texp=23'}  \n",
       "2  {'filt=I+z', 'texp=15'}  \n",
       "3    {'filt=i', 'texp=16'}  "
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "import SPOCK.stats as SPOCKstats\n",
    "\n",
    "SPOCKstats.read_night_plans_server(telescope = 'Io',date = '2020-10-12')\n",
    "\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.0"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}