EMsoft SDK Superbuild

IMPORTANT NOTE

If you find bugs and fix them PLEASE consider submitting a "Pull Request" from your fork to the official repository. This will allow the entire EMsoft community to benefit from your bug fixes.

Introduction

This cmake project will build an EMsoft SDK by downloading all the necessary 3rd party libraries as prebuilt binaries or as source code and compiling those libraries.

Prerequisites

CMake 3.15.x installed on system
Compiler Suite installed on system
Fortran compiler installed on system
Git installed on the system

Supported Platforms

Operating System	C/C++ Compiler	Fortran Compiler
macOS (>=10.13)	Xcode Native tools (10/11)	GFortran 6.3.0 or Intel Fortran 19**
Windows (10)	Visual Studio 2015 (CE/Pro)	Intel Fortran v17/v19
Linux (Ubuntu 16.x, CentOS 7.x)	GCC 7.x and Above, Clang 3.8 and greater	GNU Fortran 6.3.5 20160904 or newer

**macOS Note: If you are installing Intel Fortran try to install into a location other then /opt/intel which is the default. Try /opt/intel_sw instead.

Git Locations

Git verison 2.x is required.

Operating System	Notes
macOS (10.13)	CLI comes with Xcode, SourceTree for a nice GUI application
Windows (10)	SourceTree. Download and install the app
Linux (Ubuntu 16.x, CentOS 7.x)	Use your package manager to install git.

Libraries that are Compiled

Library	Version	Notes
HDF5	1.10.5	Compiled from Source
CLFortran	0.0.1	Compiled from Source on GitHub
FFTW	3.3.5	Compiled (macOS/Linux)
Intel MKL	2019_xxxx	Precompiled for IFort compilers (windows & macos)
Json-Fortran	4.2.1	Compiled from source on GitHub
Eigen	3.3.5	Compiled from Source
Qt 5	5.12.4	Precompiled Binaries from www.qt.io

macOS/Linux Instructions

Install your compiler tools
Install CMake on your system
Install a Fortran compiler on your system
Install Git on your system
Clone this repository onto your hard disk.

open a terminal and invoke the following commands

 cd EMsoftSuperbuild
 mkdir Debug
 cd Debug
 cmake -DEMsoft_SDK=/Some/Path/To/EMsoft_SDK -DCMAKE_BUILD_TYPE=Debug ../
 make -j
 cd ../
 mkdir Release
 cd Release
 cmake -DEMsoft_SDK=/Some/Path/To/EMsoft_SDK -DCMAKE_BUILD_TYPE=Release ../
 make -j

Windows Instructions

Currently ONLY NMake files are supported. Visual Studio support is being looked at

Install your compiler tools
Install CMake on your system
Install a Fortran compiler on your system
Install Git on your system
Create the following Directories:
- C:/Users/[USERNAME]/EMsoft_SDK
- C:/Users/[USERNAME]/EMsoft-Dev

Open a command prompt and invoke the following commands

 cd C:/Users/[USERNAME]/EMsoft-Dev
 git clone git://www.github.com/emsoft-org/EMsoftSuperbuild
 cd EMsoftSuperbuild
 mkdir Debug
 cd Debug
 cmake -G "NMake Makefiles" -DEMsoft_SDK=C:/Users/[USERNAME]/EMsoft_SDK -DCMAKE_BUILD_TYPE=Debug ../
 nmake
 cd ../
 mkdir Release
 cd Release
 cmake -G "NMake Makefiles" -DEMsoft_SDK=C:/Users/[USERNAME]/EMsoft_SDK -DCMAKE_BUILD_TYPE=Release ../
 make -j

The initial run of CMake is going to take REALLY long time because it will be downloading the full Qt 5.x installer which is about 3~4 GB in size. On macOS systems it then must verify the .dmg, mount it and run the installer (which verifies the .app). Go get coffee. Compiling (the 'make -j' part) should not take that long, only about 5 minutes or so.

NOTE: there is currently a known issue where the Qt 5.x installer will NOT actually run during the Linux cmake process. If the user does NOT want to build the GUI application then this is fine. If the user does want to build the GUI application then they will need to install Qt 5.x themselves. The download will be at /path/to/EMsoft_SDK/superbuild/Qt/download

The developer can use CMakeGui if they would like instead of the command lines. The only required variable are the path to where you want the EMsoft_SDK folder and the build type (Debug or Release)

Once the SDK builds correctly, no errors are reported on the command line, then the developer can proceed to clone and build EMsoft itself.

jmunshi1990/EMsoftSuperbuild