Triumvirate 0.1.0

Three-point clustering measurements in large-scale structure analyses.

Three-Point Clustering Measurements in LSS

Triumvirate is a Python/C++ software package for measuring three-point (and two-point) clustering statistics in large-scale structure (LSS) cosmological analyses.

Documentation

Comprehensive documentation including the scientific background, installation instructions, tutorials and API reference can be found at triumvirate.readthedocs.io.

Installation

Python package

Triumvirate as a Python package is distributed through PyPI and conda. Instructions for installation can be found on the Installation page in the documentation.

C++ library & program

Triumvirate as either a C++ library or a ‘black-box’ C++ program can be built using make. Instructions for compilation can be found on the Installation page in the documentation.

Development mode

Both the Python package and the C++ library/program can be set up in development mode with make. First check the required dependencies, namely the GSL and FFTW3 libraries, are installed. Then git clone the GitHub repository and git checkout the branch/release to be edited:

$ git clone [e-mail]:MikeSWang/Triumvirate.git --branch <branch-or-release>
$ cd Triumvirate

Then at the repository directory root, run

$ make clean
$ make [py|cpp]install [useomp=(true|1)]

where install builds both and pyinstall/cppinstall is for Python/C++ build only; you may also replace this with cpplibinstall or cppappbuild above to compile the C++ static library or binary executable only. To enable OpenMP parallelisation, append useomp=true or useomp=1 to the end of the second line as shown above.

The latest release is on the main branch. The default Makefile (located at the repository directory root) suits most use cases, but you may modify it as appropriate for your need.

Note

See the Installation page in the documentation for more details about the required dependencies.

Warning

Ensure your C++ compiler has OpenMP support and is configured accordingly. The default Makefile (located at the repository directory root) assumes the GNU compiler. See the Installation page in the documentation for more details.

Note

Pass option -j[N] -O to make to run multiple concurrent jobs (optional N is the number of parallel jobs; see GNU Make Manual).

Attribution

To acknowledge the use of Triumvirate in your published research, please cite the publications linked above which contain the relevant information in the BibTeX format.

Acknowledgement

This project has received funding from the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (Grant agreement No. 853291).

Key underlying numerical algorithms were originally developed by Naonori S Sugiyama, and are available in the GitHub repository hitomi.

Contributing

User feedback and contributions are very welcome. Please refer to the contribution guidelines.

Releases

Changes in current and past releases are listed in the change log.

Licence

Triumvirate is made freely available under the GPL-3.0 licence. Please see Licence (located at the repository directory root) for full terms and conditions.

© 2023 Mike S Wang & Naonori S Sugiyama