-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Addding README for the master branch.
- Loading branch information
Jessica Lu
committed
May 5, 2016
1 parent
c67fd6b
commit 856522c
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# OSIRIS Data Reduction Pipeline | ||
|
||
To install and run the OSIRIS DRP, you will need the following: | ||
|
||
- A working C compiler (e.g. ``gcc``) | ||
- A copy of the compiled library cfitsio | ||
- A working installation of IDL | ||
|
||
## Pipeline Version | ||
|
||
The current pipeline version is v3.2 and is released in the master branch of this repository. Clone the repository, compile, and run. | ||
|
||
If you would like to try out the development version for reducing data, you can switch to the the develop branch. | ||
|
||
If you would like to work on OSIRIS pipeline code, please fork the develop branch into your own git account. Once your modifications are complete, submit a pull request. | ||
|
||
## Running the Pipeline | ||
|
||
Please check out the OSIRIS pipeline manual: <http://www2.keck.hawaii.edu/inst/osiris/OSIRIS_Manual_v2.3.pdf> | ||
|
||
## Troubleshooting | ||
|
||
If you run into problems, please re-read this README.md. |