Projects are the working directory for a given experiment. It contain all experiment specific parts of the conversion, analysis and simulation. It contains the user analysis and simulation libraries, as well as local version of user selected plugins referred as duplicates.

Creating a new project

The new-project command will create and register a new project. A folder named <project-name> will be create in the current directory. nptool will copy all basic files and folder. The project will be register in the current environment data base.

nptool --new-project <project-name>

Compiling your project

nptool projects compilation is performed via CMake. We recommend the following operation to perform a project compilation:

mkdir build install
cmake -B build -DCMAKE_INSTALL_PREFIX=./install ./
make -C build install

mkdir build install
cmake -GNinja -B build -DCMAKE_INSTALL_PREFIX=./install ./
ninja -C build install

Projects navigation

All projects can be accessed from any directory using the npp command, which support tab completion.

npp <project-name>

Plugin duplicate

A duplicate is a local version of an installed plugin. Duplicate can only be created inside a valid nptool project folder. When a project use a duplicate, the local version is used by the framework instead of the standard version.

nptool --duplicate <plugin-name>

The duplicate command will copy the plugin source directory locally, and edit the project CMakeLists.txt file for compilation. Running make or ninja will compile the duplicate automatically.

make -C build install

ninja -C build install