Installation¶
Requirements¶
The MEGARA Pipeline package requires the following packages installed in order to be able to be installed and work properly:
- python 2.7
- setuptools
- numpy >= 1.7
- scipy
- astropy >= 1.0
- numina >= 0.13
- scikit-image
Additional packages are optionally required:
Installing MEGARA DRP¶
Using Conda¶
TBD
Using pip¶
To install with pip, simply run::
pip install --no-deps megaradrp
Note
The --no-deps
flag is optional, but highly recommended if you already
have Numpy installed, since otherwise pip will sometimes try to upgrade
your Numpy installation, which may not always be desired.
MEGARA DRP is registered in the Python Package Index. That means (among other things) that can be installed inside the environment with one command.
(myenv) $ pip install megaradrp
The requirements of megaradrp will be downloaded and installed inside
the virtual environment. Once the installation is finished, you can check
by listing the installed recipes with the command line interface tool numina
:
(myenv) $ ./bin/numina show-instruments
INFO: Numina simple recipe runner version 0.13.0
Instrument: MEGARA
has configuration 'default'
has pipeline 'default', version 1
has pipeline 'experimental', version 1
Building from source¶
The latest stable version of MEGARA DRP can be downloaded from https://pypi.python.org/pypi/megaradrp
To install MEGARA DRP, use the standard installation procedure:
$ tar zxvf megaradrp-X.Y.Z.tar.gz
$ cd megaradrp-X.Y.Z
$ python setup.py install
The install command provides options to change the target directory. By default installation requires administrative privileges. The different installation options can be checked with:
$ python setup.py install --help
Development version¶
The development version can be checked out with:
$ git clone https://github.com/guaix-ucm/megaradrp.git
And then installed following the standard procedure:
$ cd megaradrp
$ python setup.py install
Building the documentation¶
The MEGARA DRP documentation is base on sphinx. With the package installed, the html documentation can be built from the doc directory:
$ cd doc
$ make html
The documentation will be copied to a directory under build/sphinx.
The documentation can be built in different formats. The complete list will appear if you type make
Deployment with Virtualenv¶
Virtualenv is a tool to build isolated Python environments.
It’s a great way to quickly test new libraries without cluttering your global site-packages or run multiple projects on the same machine which depend on a particular library but not the same version of the library.
Install virtualenv¶
I install it with the package system of my OS, so that it ends in my global site-packages.
With Fedora/EL is just:
$ sudo yum install python-virtualenv
Create virtual environment¶
Create the virtual environment enabling the packages already installed in the global site-packages via the OS package system. Some requirements (in particullar numpy and scipy) are difficult to build: they require compiling and external C and FORTRAN libraries to be installed.
So the command is:
$ virtualenv --system-site-packages myenv
If you need to create the virtualenv without global packages, drop the system-site-packages flag.
Activate the environment¶
Once the environment is created, you need to activate it. Just change directory into it and load with your command line interpreter the script bin/activate.
With bash:
$ cd myenv
$ . bin/activate
(myenv) $
With csh/tcsh:
$ cd myenv
$ source bin/activate
(myenv) $
Notice that the prompt changes once you are activate the environment. To deactivate it just type deactivate:
(myenv) $ deactivate
$
Installing MEGARA DFP¶
This section described how to install the MEGARA Pipeline inside the GTC Control system.
In the following we assume that we are installing with user gcsop.
Login in the gcsop account and activate the GTC environment:
$ /opt/gcs/tools/nrp -p linux -s bash
Change working directory to /work/gcsop/src_python/gtc
:
$ cd /work/gcsop/src_python/gtc
$ ls
AL DSL SSL
We have to install numina under DSL and megaradrp under AL.
Please refer to Numina manual to install Numina and its dependences under Solaris 10.
Install numina¶
First, install all the dependencies:
- setuptools
- six
- numpy >= 1.7
- scipy
- astropy >= 1.0
- PyYaml
- singledispatch
If you are installing a development version, Cython is also required.
Most are available as precompiled packages in Linux. Please refer to Numina manual to install Numina and its dependences under Solaris 10.
Then, download the source code, either from PyPI or github:
$ pwd
/work/gcsop/src_python/gtc/DSL/
$ git clone https://github.com/guaix-ucm/numina.git
$ cd numina
Create a file numina.mod with the following content:
NAME=numina
TYPE=device
l:numina:python:y
And then build and install using nmk:
$ nmk -t module.rebuild
$ nmk -t module.install
Install megaradrp¶
Change directory to /work/gcsop/src_python/gtc/AL/ and download the source code of megaradrp, either from PyPI or from github:
$ pwd
/work/gcsop/src_python/gtc/AL/
$ git clone https://github.com/guaix-ucm/megaradrp.git
$ cd megaradrp
Create a file megaradrp.mod with the following content:
NAME=megaradrp
TYPE=device
l:megaradrp:python:y
And then build and install using nmk:
$ nmk -t module.rebuild
$ nmk -t module.install
You can check that everything works by running the numina command line tool:
$ numina show-instruments
Instrument: MEGARA
has configuration 'default'
has pipeline 'default', version 1