Overview
3ptWL-mod: Weak-Lensing Three-Point Modeling
Project Team
- Scientific authors:
Alejandro Aviles, Juan Carlos Hidalgo, Eladio Moreno, Gustavo Niz, Mario A. Rodriguez-Meza, Sofía Samario, and collaborators.
- Emulator workflow:
Sadi Ramirez and contributors.
- Repository:
Scientific Scope
3ptWL-mod is a C code for modeling multipoles of the three-point correlation function of projected scalar fields on the sphere. Its main application is the weak-lensing convergence field. The numerical pipeline projects a matter bispectrum into angular multipoles and evaluates \(\zeta_m(\theta_1,\theta_2)\) on a configurable angular grid.
The available model branches include standard perturbation theory, a power-spectrum-squared approximation, an effective-field-theory prescription, and a Takahashi/Halo-model inspired branch. See 3PCF Model Reference for the scientific conventions and Command-Line Usage for the run-time controls.
Public Interfaces
The repository provides the wlcf command-line executable,
libwlcf.a static library, and wlcfpy Python extension. These names are
retained from the original wlcf project so existing analysis scripts can
continue to use the public API while the repository name describes its
scientific purpose more directly.
All run products are written beneath rootDir and use prefix where
applicable. Typical products include the angular grid, 3PCF multipoles,
bispectrum multipoles, background tables, and a complete used-parameter file.
Installing and Getting Started
Read Installation for dependencies and build configuration, then follow Quickstart for a reduced validation run. For a no-clone visual start, open the Google Colab: Four-Model Comparison notebook. The Tutorials section covers the full Python and neural-network workflows.
Documentation Builds
Build the HTML documentation with:
python3 -m pip install -r docs/requirements.txt
make -C docs html
The hosted documentation is available on Read the Docs.
License
3ptWL-mod is distributed under the MIT license. See Citing and Acknowledgements for the scientific references and acknowledgement guidance.