# NBodylib

**Repository Path**: mirrors_ICRAR/NBodylib

## Basic Information

- **Project Name**: NBodylib
- **Description**: Libary for numerical simulations
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

================================================================================================

    NBodylib

================================================================================================
    developed by:
================================================================================================

    Pascal Jahan Elahi (continuously)
    Additional contributors:
    James Willis
    Rodrigo Canas
    Rodrigo Tobar

================================================================================================

    Content

================================================================================================
    doc/        contains Doxygen generated latex and html file of code
    src/        contains source code for the libraries
    lib/        library containing libMath, libNBody, libKD, libAnalysis, libCosmology,
                libInitCond
    include/     include files
    NBodylib/doc/ contains Doxygen generated latex and html file of code

================================================================================================

    Compiling (see documentation for more information)

================================================================================================

    NBodylib uses CMake as its build tool. cmake is used to perform system-level checks,
    like looking for libraries and setting up the rules for the build, and then generates the
    actual build scripts in one of the supported build systems. Among other things, cmake supports
    out-of-tree builds (useful to keep more than one build with different settings, and to avoid
    cluttering the original source code directories) and several build system, like make and
    ninja files.

    The simplest way of building is, standing on the root your repository, run cmake to produce
    Makefiles and then compile with these steps:

    mkdir build
    cd build
    cmake .. # By default will generate Makefiles
    make all

    There are a variety of options that can be invoked
    and these can be viewed using
    cmake -LH
    (though this only works after having run cmake at least once)

    Although documentation is present on the readthedocs site, extra documentation can be produced
    by typing
    make doc
    which will produce html and latex documents using Doxygen. This will be located in
    doc/html/index.html
    and
    doc/latex/refman.tex

    Note that this repo and all variants do not support non-Unix environments. (Mac OS X is fine; Windows is not).

================================================================================================

    Using Library 

================================================================================================