Skip to content

Commit 7515c57

Browse files
committed
README doc for github - how to use this code
1 parent b245442 commit 7515c57

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Code which enables users to apply a trained XGBoost model to
33
IRAC exoplanet or brown dwarf staring mode data
44

5-
#Summary
5+
# Summary
66
The main systematic in high precision photometry with Spitzer IRAC is
77
the intrapixel response function. We see variations in the fluxes in
88
light curves due to the combination of under-sampling with small
@@ -25,26 +25,26 @@ This code only works on ch2 IRAC data (4.5microns) where the data is
2525
observed on the sweet spot pixel (pixel 15, 15 of the subarray or same
2626
pixel observed in full array)
2727

28-
#Requirements
28+
# Requirements
2929
This code requires IDL, python, and jupyter notebooks
3030

31-
IDL
32-
pmap_correct - download here: https://irachpp.spitzer.caltech.edu/page/contrib
33-
included here -
34-
box_centroider, dewrap2, fpa1t2, fpa2t2, get_centroids,
31+
IDL
32+
- pmap_correct - download here: https://irachpp.spitzer.caltech.edu/page/contrib
33+
- included here -
34+
- box_centroider, dewrap2, fpa1t2, fpa2t2, get_centroids,
3535
phot_exoplanet_csv
3636

3737
Python
38-
batman
39-
exoparams
40-
sklearn
41-
astropy
42-
scipy
43-
pylab
44-
lmfit
45-
functools
38+
- batman
39+
- exoparams
40+
- sklearn
41+
- astropy
42+
- scipy
43+
- pylab
44+
- lmfit
45+
- functools
4646

47-
#What is Included (and what does it do)
47+
# What is Included (and what does it do)
4848
- apply_ML_IRAC.ipynb is the main python code to apply model to science
4949
data
5050
- phot_exoplanet_csv.pro is the main IDL code to do photometry
@@ -53,7 +53,8 @@ data
5353
- XO3*.csv files are the photometry files for the 10 XO3 observations
5454

5555

56-
#How to use this code
56+
# How to use this code
57+
5758
0. Download the pmap_correct.pro code and associated pmap files from the SSC
5859
website (they are too large to include with this github repository)
5960

@@ -75,7 +76,8 @@ website (they are too large to include with this github repository)
7576
directory location, observation name, and planet name of the dataset in the top
7677
cell of the notebook.
7778

78-
4. Further refinements:
79+
4. Further refinements:
80+
7981
a) Included here are two models which both are able to remove
8082
systematics (two .pkl files). They are different and require
8183
different feature sets, but both can be accomodated with the csv

0 commit comments

Comments
 (0)