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 static library or a binary executable 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, provided that dependency requirements are satisfied (GSL and FFTW3 libraries are mandatory while an OpenMP library is optional).
First git clone the desired branch/release from the GitHub repository and change into the repository directory path:
git clone git@github.com:MikeSWang/Triumvirate.git --branch <branch-or-release>
cd TriumvirateThen, execute in shell:
make clean
make [py|cpp]install [useomp=(true|1)]where cpplibinstall or cppappbuild respectively builds the C++ static library or binary executable only, cppinstall builds both, pyinstall builds the Python package only, and install builds all of the above. To enable OpenMP parallelisation, append useomp=true or useomp=1 to the end of the second line as shown above.
Attribution
To acknowledge the use of Triumvirate in your published research, please cite the publications linked above; for convenience, you can refer to the files CITATION.cff and CITATION.md for the relevant information in different formats.
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 ID: 853291).
Key underlying numerical algorithms were originally developed by Naonori S Sugiyama, and are available in the GitHub repository hitomi.
We thank the JOSS reviewers, William Coulton (@wcoulton) and Alfonso Veropalumbo (@alfonso-veropalumbo), for their valuable feedback and suggestions (openjournals/joss-reviews#5571), which have improved the functionality and documentation of the code.
Contributing
User feedback and contributions are very welcome. Please refer to the contribution guidelines.
Discussions & Wiki
A community forum for users and developers is hosted on GitHub, where you can receive announcements, post questions, share ideas and get updates.
A wiki site collects wisdoms for specific use cases and user environments.
Releases
Release notes are included in the change log.
Licence
Triumvirate is made freely available under the GPL-3.0 licence (or any later version). Please see LICENCE (located at the repository directory root) for full terms and conditions.
© 2023 Mike S Wang & Naonori S Sugiyama
1 maintainer
Metadata
1 maintainer
Release files for Triumvirate 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| triumvirate-0.5.0.tar.gz | 1.2 MB | Details |
Built distributions (wheels)
Total release size: 65.2 MB
Release files / triumvirate-0.5.0.tar.gz
| Download URL | triumvirate-0.5.0.tar.gz |
|---|---|
| Size | 1.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3f9fa1d77c55029aef9666253e95ed21d91956df2068ae21d71bea48b326e55d
|
|
BLAKE2b-256 checksum How to use checksums |
c48e719a8d88aead8ce347cb727a353f14d8f0d8e0a330d7e69a9fee1eafe763
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp312-cp312-manylinux_2_28_x86_64.whl
| Download URL | Triumvirate-0.5.0-cp312-cp312-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 8.8 MB |
| Tags | CPython 3.12 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
3056bea5e05c2dbd0c73844abe62cc342e4e040dfbca9a5263c48ad7ae5d434c
|
|
BLAKE2b-256 checksum How to use checksums |
2f368eafa5e9fd2e06611c46f7cb9364fa767b6a73f355bcb4c41a4984340233
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp312-cp312-manylinux_2_28_aarch64.whl
| Download URL | Triumvirate-0.5.0-cp312-cp312-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 8.0 MB |
| Tags | CPython 3.12 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
475f90dbc58303f7b8e4cdc3a194ebaefaa7967f7b76e5363276a6154c00bd0b
|
|
BLAKE2b-256 checksum How to use checksums |
7990a09244cc63a56151617d39181a15900441b2cb56731f4396e96153082e97
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | Triumvirate-0.5.0-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 2.0 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
0e19fd4916739141c4c7181eda4f1d3c32cd234ddaac56385b7586b93787d73e
|
|
BLAKE2b-256 checksum How to use checksums |
96f2b20a162ef0abbf288928d9d93392c15326dfd5ffe99389b52792f86df1b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp312-cp312-macosx_10_15_x86_64.whl
| Download URL | Triumvirate-0.5.0-cp312-cp312-macosx_10_15_x86_64.whl |
|---|---|
| Size | 2.7 MB |
| Tags | CPython 3.12 macOS 10.15+ x86-64 |
|
SHA-256 checksum How to use checksums |
7a5267b1c59c405762dccf539ad5669a4c5a94c11af9fe42d08f7308e8b4d2f8
|
|
BLAKE2b-256 checksum How to use checksums |
da3af0c75f670bf16b1dddca098e711672f5e9f59bca4574720f218d85ec35c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp311-cp311-manylinux_2_28_x86_64.whl
| Download URL | Triumvirate-0.5.0-cp311-cp311-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 8.8 MB |
| Tags | CPython 3.11 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
049badd609139cdb58a9a879ae8f8c02ec809ec05b13b5f5a7263512d2c4dd47
|
|
BLAKE2b-256 checksum How to use checksums |
488e60eaf8a972ac18e31af5398fee575dbc725504c1f420d292c22c65ebd0b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp311-cp311-manylinux_2_28_aarch64.whl
| Download URL | Triumvirate-0.5.0-cp311-cp311-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 8.0 MB |
| Tags | CPython 3.11 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
4664c68247c1a4cb177cb90caa439ac18abb9c5a271fbeb7edf957b63bd05538
|
|
BLAKE2b-256 checksum How to use checksums |
b51739b538d64971ab343f521a703af1fb0f57e624c967190402484e5c52344d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | Triumvirate-0.5.0-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 2.0 MB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
a3b1153e0fa86e65d4c8b21ca553690d1d6e3878ae499f8b818a4b4274f3e54f
|
|
BLAKE2b-256 checksum How to use checksums |
86a61a64ffe19ace52642b89c8f24bb6584eae681e15a4ee07655f4ed8a02ae4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp311-cp311-macosx_10_15_x86_64.whl
| Download URL | Triumvirate-0.5.0-cp311-cp311-macosx_10_15_x86_64.whl |
|---|---|
| Size | 2.7 MB |
| Tags | CPython 3.11 macOS 10.15+ x86-64 |
|
SHA-256 checksum How to use checksums |
8dcb33267deb59c18fabeaa5f66d80b9fb785972c614b022507664cae9280384
|
|
BLAKE2b-256 checksum How to use checksums |
71f86eba0b6f5974f744a19173eb6fd2773ecc590ed558c8421f83eb5133a0f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp310-cp310-manylinux_2_28_x86_64.whl
| Download URL | Triumvirate-0.5.0-cp310-cp310-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 8.6 MB |
| Tags | CPython 3.10 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
1f2868e0f2133be7e99af0a56aaadfad51df4a22a0b3f1a4587439d1e8035d19
|
|
BLAKE2b-256 checksum How to use checksums |
ec27d752f6232fb25bf98e42ad89227b3086ac6afd2373cdc8840cfdbd617358
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp310-cp310-manylinux_2_28_aarch64.whl
| Download URL | Triumvirate-0.5.0-cp310-cp310-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 7.8 MB |
| Tags | CPython 3.10 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
e0f000863a8e80c268e5899ebefc81c3e15232911f914647d4fc7a3b333e23f1
|
|
BLAKE2b-256 checksum How to use checksums |
e52aabeaf67ed0bca2f6b30988538382156c9a04c8bf9180a10a893dd170666e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | Triumvirate-0.5.0-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 2.0 MB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
f8733535ab55d59a4579d33306671dd670f8ee0bc3562b91b354aa297f4272fc
|
|
BLAKE2b-256 checksum How to use checksums |
dbbd93ec8b174fc81fa5a1cf1eeeaee6a4847597af0701a77eb299257a74904e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
Release files / Triumvirate-0.5.0-cp310-cp310-macosx_10_15_x86_64.whl
| Download URL | Triumvirate-0.5.0-cp310-cp310-macosx_10_15_x86_64.whl |
|---|---|
| Size | 2.7 MB |
| Tags | CPython 3.10 macOS 10.15+ x86-64 |
|
SHA-256 checksum How to use checksums |
8d6f77d002ca0daf21867ca4dd30ff85964c795b1265eed0dec223f32c6f3bd0
|
|
BLAKE2b-256 checksum How to use checksums |
c1556d794daa4aef451739139b4863778cf4e29d48e1235ca251174b19eea0ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.9
|
