Installation

To install Gundam, you have two choices: (1) use pip, or (2) build from scratch. Method (1) is useful if you simply want to use gundam. Method (2) on the other hand allows easy access to modify or extend the Fortran counting routines.

Option 1: Building from pip

To install via pip execute:

pip install gundam

Option 2: Building from source

If you want to contribute to the package, you need to clone the Gundam repository and install with the “dev” optional dependencies.

git clone https://github.com/lincc-frameworks-mask-incubator/gundam.git
cd gundam
pip install -e .'[dev]'
pre-commit install

By default, this will compile and build the library in-place. Feel free to modify the CMakeLists file to suit your needs.

Dependencies

  1. Python: 3.5 or later

  2. GCC compiler (Fortran & C)

  3. Numpy, matplotlib, astropy, scipy

  4. munch

  5. pymorton (only needed when playing with Morton ordering, instead of the default “pixel” sorting)

Any of the above can be installed with pip or conda. A few other codes for Morton and Hilbert ordering are also included if you wish to experiment with alternative sorting methods, but are not really needed if you stick with the default sorting scheme).

Gundam has been tested under Anaconda 4.4.0, Python 3.6.1, Numpy 1.12.1 and gcc 7.1.1, running OpenSuse in an Intel platform.