SBody

The “S” in the name of SBody stands for “Small”, “Some”, and “Speed”.

[!IMPORTANT] SBody is currently migrating from GSL to Boost.

• Library & Tool

  • Required

    • CMake

    • Boost

    • GSL

  • Submodule

  • Optional

• Changelog

• License

Library & Tool

Required

CMake

CMake is an open-source, cross-platform family of tools designed to build, test and package software. SBody use CMake to get built on different platforms.

• Linux: run apt install cmake or download and install from homepage.

• macOS: Install CMake via Homebrew, with command brew install cmake.

Boost

The Boost C++ Libraries are open source, peer-reviewed, portable and free.

• Linux: run apt install libboost-all-dev or refer to the instructions on the homepage.

• macOS: Install Boost via Homebrew, with command brew install boost.

GSL

The GNU Scientific Library (GSL) is a numerical library for C and C++ programmers.

• Linux: run apt install libgsl-dev or download and install from homepage.

• macOS: Install GSL via Homebrew, with command brew install gsl.

Submodule

• `indicators <https://github.com/p-ranav/indicators>`_: show the progress bar.

• `fmt <https://github.com/fmtlib/fmt>`_: format the output.

Optional

• Doxygen: generate the documentation.

• OpenMP: build parallel version.

• Python:

  • Breathe: convert the Doxygen documentation to Sphinx.

  • NumPy: SBody output can be saved in NPY format version 2.0.

  • pybind11: build Python interface.

  • Sphinx: documentation shown in the webpage.

Changelog

Changelog can be found here.

License

This program uses GSL, so the program can only be distributed under the terms of the GNU General Public License (GPL).