Binary versions
Before you install from source code you might want to check that already compiled binary versions are available to you. Magics and third-party dependent software packages might be available as binary packages for you platform in form of RPMs or Debian packages. You might find them by going to the software search services, such as for OpenSuSE and SLES at http://software.opensuse.org/search (select "Search options" - "Include users' home projects"). Ubuntu maintains a Magics version in their system default repository.
Installing Magics through conda and pip
If you want to use Magics only through Python you have now choices to install Magics with your favourite Python package manager. With the release of Magics 4.0.0 (Feb 2019), the Python interface is separated from the library. This allowed the packaging through pip and conda.
Using pip
When using pip it is required to have the Magics library installed on the system!
| Code Block |
|---|
pip install Magics |
Ref: https://pypi.org/project/Magics/
Using conda
Conda will install the Magics library and all its dependencies for you. Please make sure to activate you conda environment before running your python program.
| Code Block |
|---|
conda install -c conda-forge Magics=4.0.0 conda activate python my-magics-script.py |
Building Magics from source yourself
Requirements
The following table lists the dependency Magics requires to be build from source. Please note, if you install this package from source you also might have to install the respective "-devel" packages of dependencies.
| Compilers | |||
|---|---|---|---|
| C++ | http://gcc.gnu.org/ | ||
| Fortran | http://gcc.gnu.org/fortran/ | If Fortran or BUFR support needed | |
| Utilities | |||
make | http://www.gnu.org/software/make/ | ||
| cmake | https://cmake.org | version >3.1 | |
| Python Support | |||
| python | http://www.python.org/ | versions 2.7 and 3.x supported | |
| python-jinja2 | pip install jinja2 | ||
| Third party libraries | |||
| proj | http://trac.osgeo.org/proj/ | Proj4 to handle projections | |
| boost | http://www.boost.org/ | used for coastlines | |
| netcdf | http://www.unidata.ucar.edu/software/netcdf/ | if netcdf support needed Please note: You also need to install the legacy C++ interface and HDF5 | |
| pango | http://www.pango.org/ | if png/pdf support needed | |
| expat | http://expat.sourceforge.net/ | for XML parsing | |
| ECMWF libraries | |||
| ecCodes | ECC | Enables GRIB and BUFR support | |
| odb-api | ODB-API Home | if ODB support needed | |
| Include Page | ||||
|---|---|---|---|---|
|
Magics specific CMake options
After changing into the build Magics directory, the user has to run CMake with his/her own options. The command gives feedback on what requirements are fulfilled and what software is still required. Table below gives an overview of the different options of configure. The default (without any options) will compile a share library only and install it in /usr/local/.
| cmake options | doc | default |
|---|---|---|
| ECCODES_PATH | where to find eccode ( if non-standard installation ) | |
| ENABLE_NETCDF | enable netcdf support | on |
| NETCDF_PATH | where to find netcdf ( if non-standard installation ) | |
| ENABLE_ODB | enable odb support | off |
| ODB_API_PATH | where to find odb ( if non-standard installation ) | |
| ENABLE_PYTHON | enable python interface | auto |
| ENABLE_FORTRAN | enable fortran interface | on |
| ENABLE_METVIEW | enable metview support(and Qt support) | off |
| ENABLE_CAIRO | enable Cairo support | on |
| BOOST_ROOT | where to find boost ( if non-standard installation ) | |
| PROJ4_PATH | where to find proj4 ( if non-standard installation ) |
To make sure that a feature is really enabled, you will have to specify with the option ex: -DENABLE_GRIB=ON. In that case CMake will fail if the GRIB support can not be enabled.
Testing your build
The Magics code contains a directory called test in which, in separate sub-directories, tests for the various interfaces of Magics are provided. Test programs in Fortran, C, Python and MagML are compiled and run if MAGPLUS_HOME=$PWD make check is invoked from the root directory. (Note that the MAGPLUS_HOME needs to be set!)
The output of the tests should verified before the library is installed. This setup does not check if the user setup is correct, but the code in test can be used to do so. More examples of source code can be found on the Magics web gallery .