As indicated in the main readme there are a number of prerequisites for GEMINI. This readme covers some details of how to install these on various platforms. We focus here on ease of use and describe the “least effort” methods for getting needed software.
You will need to install XCode through the app store. Then it may be necessary (depending on your OS version) to manually install XCode command line tools:
xcode-select --install
It is strongly recommended that you install Homebrew by following instructions on the homebrew website. Instructions in this readme assume that you will use this package manager to get most of the prereqs. Users have also reported that Macports works fine for getting required packages, as well. Both are available from the linked websites.
Many default installations will not have the required compilers, e.g. there is no default Fortran compiler in Mac OS, and many Linux distributions install without a C++ compiler. See Readme_compilers for more info.
MPI is often installed using a package manager since it can take a very long time to build from source. See Readme_mpi for more info.
Python ≥ 3.7 is required for a number of GEMINI operations. We recommend installing either anaconda or miniconda. Open source distributions are available for download at these websites. Otherwise, build Python from scratch.
Extensive scripting front-ends for simulation preparation and analysis exist in MATLAB. These are not required (implementations exist in python); however they are very useful and in some cases contain functionality not yet implemented in python. MATLAB can be obtained from the Mathworks web site and requires a paid license for use.
CMake is used extensively for GEMINI’s build system and its continuous integration system and so is required for any deployments. In general on Linux, MacOS, and Windows the easiest CMake install is:
pip install cmake
OR, on MacOS the latest cmake can be obtained from your package manager, e.g.:
brew install cmake
Most Linux distributions (even recent ones) come with an outdated cmake package. There are several easy ways to get an updated CMake:
snap install cmake
OR, install the distribution cmake package (which will be outdated) and use it with our update script to get a newer version, e.g.:
apt install cmake
git clone https://github.com/gemini3d/external
cmake -S external/scripts/install_cmake
OR, install cmake from source by first downloading and extracting the latest source from cmake.org:
cd <cmake source code directory>
./bootstrap --prefix=<install directory>
make -j
make install