Skip to content
Snippets Groups Projects
To learn more about this project, read the wiki.
README.md 8.21 KiB

Folder instructions

This directory contains the configuration and building system.

Instructions

The set-up and building process of NP_TMcode is based on tha automatic detection of the system capabilities, through an autoconf generated configure script. In case the user wants to override the default configuration, several options are available to modify the configuration behaviour. Use:

./configure --help

to obtain a list of the available configuration options. We refer to the code inline documentation and to the PDF release notes of the distribution for advanced instructions on code set up and execution. In the following sections, we give instructions for a simple installation and some elementary tests.

Use of this code and of any derived implementation should credit the original authors. Scientific publications should do so by citing the following references:

  • Saija et al. 2001, ApJ, 559, 993, DOI:10.1086/322350
  • Borghese, Denti, Saija 2007, Scattering from Model Nonspherical Particles (ISBN 978-3-540-37413-8), DOI:10.1007/978-3-540-37414-5

Installation

The proper way to install the code and execute it is based on pre-configured builds handled by GNU make. To install the code on your local machine, you should enter the build folder and issue:

./configure [CONFIGURE_OPTIONS]

where CONFIGURE_OPTIONS are optional arguments used to enable and disable specific code features, such as parallel implementation and GPU offload of calculations. These features are enabled by default, if the local system has the hardware and software ability to support them. See the help pages of the configure script for more details on the available optional features.

Code work-flow

The original code produces output in the current working directory (the path where the code is executed from). The build directory is intended to collect local builds and test run output in a safe place, without cluttering the code development folders, thus keeping the source folders as clean as possible.

This section describes the use of the single programs that make up the NP_TMcode suite, once the binaries have been properly built.

NOTE: This set of instructions applies to the serial code implementation only. Please, refer to the Release Notes of NP_TMcode-M8.03 for more details on how to build and use a parallel implementation of the code.

cluster

  1. cd to the build/cluster folder.

  2. Run edfb_clu:

    ./edfb_clu

  3. Run clu:

    ./clu

NOTE: both edfb_clu and clu expect an input which is assumed to be in a folder named ../../test_data/cluster/ (i.e. two levels above the current execution path)

  1. Run np_cluster:

    ./np_cluster