Table Of Contents

Previous topic

The NDPP Continuous Energy Data Pre-Processing Code

Next topic

User’s Guide

This Page

Quick Install Guide

This quick install guide outlines the basic steps needed to install NDPP on your computer. For more detailed instructions on configuring and installing NDPP, see Installation and Configuration in the User’s Manual.

Prerequisites

In order to compile and run NDPP, a number of prerequisite software packages and libraries may be needed. These include:

  • A Fortran compiler such as gfortran (version 4.6 or newer)
  • git version control software for obtaining source code (optional)
  • HDF5 Library for portable binary output format (optional and not yet implemented)

Obtaining the Source

All NDPP source code is hosted on GitHub. You can download the source code directly from GitHub or, if you have the git version control software installed on your computer, you can use git to obtain the source code. The latter method has the benefit that it is easy to receive updates directly from the GitHub repository. With git installed and setup, the following command will download the full source code from the GitHub repository:

git clone git@github.com:ndpp/ndpp.git

By default, the cloned repository will be set to the development branch. To switch to the source of the latest stable release, run the following commands:

cd ndpp
git checkout master

Compiling on Linux and Mac OS X

To compile NDPP on Linux or Max OS X, run the following commands from within the root directory of the source code:

cd src
make

This will build an executable named ndpp.

Compiling on Windows

To compile NDPP on a Windows operating system, you will need to first install Cygwin, a Linux-like environment for Windows. When configuring Cygwin, make sure you install both the gfortran compiler (version 4.6 or newer) as well as git. Once you have obtained the source code, run the following commands from within the source code root directory:

cd src
make

This will build an executable named ndpp.