Download and Installing for local use

The Goodman DRP can be downloaded and run on machines running Unix-like Operating Systems (OS) like Ubuntu or Centos. All you need is to have Python and some libraries commonly used in astronomy. The pipeline should run also on MacOS systems, but it has not been fully tested yet on this OS. We expect it may also run in the latest versions of the Windows OS, but we have not tested this.
Here is what you need to have installed to run the pipeline:

If you choose to install the Goodman DRP on your machine, we highly recommend the use of a Python Virtual Environment.
That will prevent any installation, update or upgrade, wreaking havoc with the Python installed in your Operational System, which may render your machine un-bootable, and require a full OS re-install.
If you really want to install the pipeline natively on your system, you should be prepared for the possible consequences. ;-)
Before you start installing all the packages, consider download and install Anaconda, a manager for Python Virtual Environments.
(We actually recommend Miniconda, since it is cleaner).

Please, refer to the Goodman Data-Reduction Pipeline - User Manual for more details on creating the proper environment to install the package.

Download the Goodman DRP

Dowload the latest release in the following link. Make sure that it has a green tag that says "Latest release".

All the releases are considered stable versions, though they can still contain bugs. Please, download a released version instead of cloning the whole repository. The Goodman DRP is an ongoing work and several changes are made every day. If you clone the repository, you might end up having inconsistencies between different times that you run it. 

Installing the Goodman DRP

If you are using Anaconda, you can simply follow the instructions below. If you already have created an environment, you can skip the step 3. 

  1. Create a folder in your system, move the downloaded compressed files and decompress them.
$ mkdir <my_new_folder>
$ cd <my_new_folder>
$ mv <path_to_the_decompressed_files> ./
  1. Decompress them.
$ tar xf goodman-v<version>.tar.gz

or

$ unzip goodman-v<version>.zip

then enter to the decompressed folder:

$ cd goodman-v<version>/
  1. Use Conda to create a new environment using a pre-set environment that comes within the compressed files within the file "environment.yml":
$ conda env create -f environment.yml
  1. Activate the environment now (and every time you want to use the pipeline):
$ source activate <virtual_environment_name>

If you created the environment using the file "environment.yml", the <virtual_environment_name> is "goodman".

  1. Test if your installation will be successful:
$ python setup.py test
  1. If no errors come up, install the pipeline:
$ python setup.py install

Now you are ready to Run the Pipeline.