Obtaining the code and prerequisites

PARALLAX is hosted on the GitLab service of the Max Planck Computing and Data Facility (MPCDF)at gitlab.mpcdf.mpg.de/phoenix/parallax. The repository is part of the phoenix group, which includes other related projects.

Prerequisites

To build and run PARALLAX, you will need the following:

  • git and git-lfs for version control
  • CMake for the build system
  • A Fortran 2008 compiler (Intel or GNU compilers are recommended)
  • MPI for parallel processing
  • NetCDF library for data storage
  • Math Kernel Library (MKL): While MKL is the recommended library, PARALLAX can also be compiled without it as an experimental feature. See ... for further instructions.
  • ConfiX: This project contains configuration files and is part of the phoenix group. It is automatically downloaded as a git submodule.
  • Parallel Iterative Methods (PIM): A library used to solve 3D linear equation systems with MPI communication. It is also part of the phoenix group and automatically downloaded during compilation.
Optional/Advanced Features

For certain advanced or optional features, the following libraries are required:

  • pFUnit: Unit testing framework for Fortran. It is automatically downloaded during compilation.
  • PAccX: The Parallax Accelerator library, currently under development, implements the field solver with a multigrid preconditioner for GPU architectures. It is available within the phoenix group and automatically downloaded during compilation.
  • GMRES from Cerfacs: An alternative 3D solver to the PIM solver. This is hosted within the phoenix group at this link and automatically downloaded during compilation.
  • VTKFortran: A library for 3D visualization, enabling the export of the mesh in a locally field-aligned representation in VTK format. It is automatically downloaded during compilation.
  • PETSc: A library providing a variety of algorithms for experimenting with the field solver.
Downloading

To download the PARALLAX repository, clone it using HTTPS:

$ git clone https://gitlab.mpcdf.mpg.de/phoenix/parallax.git

Alternatively, if you have uploaded your SSH key, you can clone the repository via SSH:

$ git clone git@gitlab.mpcdf.mpg.de:phoenix/parallax.git

Once the repository is cloned, you will need to initialize and update the ConfiX submodule. Navigate to the parallax directory and run the following commands:

$ cd parallax
$ git submodule init
$ git submodule update