-
Notifications
You must be signed in to change notification settings - Fork 1
Home
Here is the wiki of the PRIME telescope photometry pipeline! Here will be pages of information on how to use the pipeline's scripts, how these scripts function, and other various things, such as recommended index and config files. I'll try my best to explain everything about the pipeline, and will be updating new and current pages over time as functionality improves!
To jump right into how to utilize the pipeline, examine the master.py and multi_master.py scripts section (as explained below!)
Most of the wiki will be about the scripts, how they function, what they produce, and how to use them.
-
Master & Multi_master: The pipeline itself will be run from either master.py or multi-master.py. For most use case scenarios and normal observations multi-master.py is sufficient, though specific scenarios may require the greater number of knobs to turn given by master.py. In any case, the sections on these scripts are the most important, though other script documentation is useful for knowing how the master scripts run. To begin to understand how to run things, I recommend first reading through multi-master.py (utilized the most), then master.py, and finally the other scripts.
-
Astrometry: This section details each of the 4 current astrometry scripts that can be used in the pipeline.
-
Photometry: This section details how photometry is generated for a chip's data, and what data products are produced.
-
Stack: This section details how the final pipeline step, stacking, works.
-
Navigate to the main page of this repo: https://github.com/Oriohno/prime-photometry. Then click the Code button and copy the HTML or SSH link.
-
Open command line and change your current working directory (cd) to the place you wish to clone the repo.
-
Finally, use the command 'git clone' as below to clone locally.
git clone https://github.com/Oriohno/prime-photometry.git
-
Begin by navigating to the .yml file included in this repo. cd to to /prime-photometry/ for ease of using the command below.
-
To create the conda environment, run the command below.
conda env create -f prime-photometry.yml -
You can then activate the environment by using:
conda activate prime-photometry
To utilize a key part of the pipeline, astrometry.net, you will need index files from which the package can pull from. See these links for key details about and where to download index files:
https://astrometry.net/doc/readme.html
For PRIME I found the 4200 series is useful, as I first downloaded those and they've worked (mostly) just fine, being built off of 2MASS. Astrometry.net recommends to download index files with sky-marks 10% to 100% the size of your images. For PRIME, individual detector images are in the 30-40' size range, thus I should download series 08 to 01. I've done this for some areas, but have yet to complete coverage.
If you want to save time (and delay the inevitable), you can download appropriate index files only for the area where your images are located. You can use these maps to determine what numbers correspond to what index files:
https://github.com/dstndstn/astrometry.net/blob/master/util/hp.png
https://github.com/dstndstn/astrometry.net/blob/master/util/hp2.png
It is also recommended to download the 4100 and some of the 5200 series, though I haven't yet tested if these are better for PRIME than the 4200.
We must place the index files in its own directory, named whatever you like. Find the 'astrometry.cfg' file, likely located where the astrometry python package is installed. It should look like this below:
https://github.com/dstndstn/astrometry.net/blob/main/etc/astrometry.cfg
Under the comment "# In which directories should we search for indices?", add your index file directory after "add_path", like the example below:
# In which directories should we search for indices?
add_path ../../../indexes
Now, astrometry.net should be able to use your index files.