Corrfunc 2.5.3

先决条件

1. make >= 3.80

2. 具有OpenMP功能的编译器，如icc，gcc>=4.6或clang >= 3.7。如果没有可用，请在theory.options和mocks.options中禁用USE_OMP选项。在HPC集群上，请参考集群文档了解如何加载编译器（通常是module load gcc或类似）。如果您使用Anaconda Python的Corrfunc，则conda install gcc（MAC/linux）应该可以工作。在MAC上，（sudo）port install gcc5也是一个选项。

3. gsl >= 2.4。在HPC集群上，请参考集群文档（通常是module load gsl将有效）。使用Anaconda Python时，使用conda install -c conda-forge gsl（MAC/linux）。在MAC上，如果需要，您可以使用（sudo）port install gsl（MAC）。

4. python >= 2.7或python>=3.4用于编译CPython扩展。

5. numpy>=1.7用于编译CPython扩展。

方法1：源安装（推荐）

$ git clone https://github.com/manodeep/Corrfunc.git
$ cd Corrfunc
$ make
$ make install
$ python -m pip install . [--user]

$ make tests  # run the C tests
$ python -m pip install pytest
$ python -m pytest  # run the Python tests

假设您的PATH中已有gcc，make和make install将在源目录中编译和安装C库+ Python扩展。如果您想将CPython扩展安装到您的环境中，则python -m pip install . [--user]应该足够了。如果您主要对Python接口感兴趣，您可以使用python -m pip install . [--user] --install-option="CC=yourcompiler"在git clone [...]和cd Corrfunc后压缩所有步骤。

方法2：pip安装

Python软件包可以通过python -m pip install Corrfunc直接安装。然而，在这种情况下，您将失去重新编译代码的能力。如果您仅使用Python接口且在一台机器（如笔记本电脑）上工作，这通常是可以接受的。对于在集群或其他具有多个CPU架构的环境中的使用，您可能会发现使用上述源安装方法更有用，以防以后需要为不同的架构编译。

$ python -m pytest --pyargs Corrfunc

OSX上的OpenMP

自动从编译器和运行时检测OpenMP支持有点复杂。如果您在编译（或运行）OpenMP时遇到任何问题，请参阅常见问题解答以获取可能的解决方案。

输入数据

输入星系（或任何离散的点分布）来自模拟。例如，星系可以是Halo Occupation Distribution（HOD）模型、Subhalo Abundance matching（SHAM）模型、Semi-Empirical model（SEM）或Semi-Analytic model（SAM）等的结果。输入的点集也可以是宇宙模拟中的暗物质晕或暗物质粒子。预期的输入点集应具有在笛卡尔XYZ中的位置。

可用的聚类统计类型

位于theory目录中的所有针对具有共动位置的宇宙盒工作的代码。各种聚类度量包括：

1. DD – 测量两个盒子之间的自相关/互相关。盒子不必是立方体。

2. xi – 测量立方宇宙盒子中的3D自相关。假设周期性边界条件。

3. wp – 在立方宇宙盒子中测量自动二维点投影相关函数。假设周期性边界条件。

4. DDrppi – 测量两个盒子之间的自相关/互相关函数。盒子不需要是立方体。

5. DDsmu – 测量两个盒子之间的自相关/互相关函数。盒子不需要是立方体。

6. vpf – 测量空域概率函数 + 单元中的计数。

输入数据

输入星系通常是来自大规模星系调查的观测星系。此外，已经投影到天空中（即，观测系统误差已被纳入，并生成了天顶位置）的模拟星系也可以使用。我们通常将这两种星系统称为“模拟”。

输入星系应指定在球坐标中，至少包括赤经（RA）和赤纬（DEC）。对于空间相关函数，还需要一个近似的“共动”距离（光速乘以红移，CZ）。

可用的聚类统计类型

所有针对模拟目录（RA、DEC、CZ）工作的代码都位于mocks目录中。各种聚类度量包括

1. DDrppi_mocks – 两个数据集之间的标准自相关/互相关。输出DD、DR和RR可以通过wprp结合来产生wp(rp)的Landy-Szalay估计值。

2. DDsmu_mocks – 两个数据集之间的标准自相关/互相关。输出DD、DR和RR可以通过Python实用程序convert_3d_counts_to_cf结合来产生xi(s, mu)的Landy-Szalay估计值。

3. DDtheta_mocks – 计算两个数据集之间的角相关函数。从DDtheta_mocks输出的结果需要与wtheta结合以获得完整的ω(θ)。

4. vpf_mocks – 在模拟上计算空域概率函数。

理论（在theory.options中）

1. PERIODIC（在wp/xi的情况下忽略）– 开关周期性边界条件。默认启用。

2. OUTPUT_RPAVG – 在每个rp分箱中输出<rp>。可能对性能有很大影响（wp的情况下约为2.2倍）。默认禁用。

模拟（在mocks.options中）

1. OUTPUT_RPAVG – 在DDrppi_mocks的每个rp分箱中输出<rp>。默认启用。

2. OUTPUT_THETAAVG – 在每个θ分箱中输出。根据编译器和CPU的能力，可能非常慢（约为5倍）。默认禁用。

3. LINK_IN_DEC – 为DDtheta_mocks创建赤纬分箱。请检查对于您期望的\theta限制，这种分箱不会产生错误结果（由于数值精度）。一般来说，如果您的\thetamax（考虑对内配对的最大\theta）太小（可能小于1度），那么您应该检查启用和禁用此选项的情况。错误通常在亚百分比级别。

4. LINK_IN_RA – 在为DDtheta_mocks启用分箱后创建赤经分箱。与LINK_IN_DEC相同的数值问题。

5. FAST_ACOS – 仅当为DDtheta_mocks启用OUTPUT_THETAAVG时相关。默认禁用。计算<\theta>需要arccos。在没有向量化的arccos（英特尔编译器，icc通过英特尔短向量数学库提供）的情况下，此计算非常慢。然而，我们可以使用多项式（使用Remez算法）来近似arccos。近似来自Geometric Tools发布的实现。根据所需的精度水平，此fast acos实现可以在文件utils/fast_acos.h中进行调整。该文件中已经存在一个更不精确的实现。请确保精度损失对您的用例不重要。

6. COMOVING_DIST – 目前Corrfunc中不支持不同的宇宙学。然而，对于模拟程序，如DDrppi_mocks和vpf_mocks，需要宇宙学参数来在红移和宇宙距离之间进行转换。DDrppi_mocks和vpf_mocks都期望接收一个红移数组作为输入；然而，启用此选项后，红移数组将被假定为包含已转换的宇宙距离。因此，如果您有红移并且想要使用任意宇宙学，那么将红移转换为宇宙距离，启用此选项，并将宇宙距离数组传递给程序。

使用命令行界面

导航到正确的目录。确保在根目录中的 theory.options 或 mocks.options 中设置选项是您想要的。如果不是，请编辑这两个文件（以及可能 common.mk），然后重新编译。然后，您可以使用对应于您感兴趣聚类度量的各个子目录中的命令行可执行文件。例如，如果您想计算完整的 3-D 相关函数 \xi(r)，则运行可执行文件 theory/xi/xi。如果您在没有任何参数的情况下运行可执行文件，程序将输出包含所有必需参数的消息。

从 C 调用

查看 run_correlations.c 和 run_correlations_mocks.c 下的示例，了解如何直接调用 C API。如果您运行 run_correlations 和 run_correlations_mocks 可执行文件，输出也将显示如何调用各种聚类度量的命令行界面。

从 Python 调用

如果一切顺利，代码可以直接从 python 调用。请参阅 call_correlation_functions.py 和 call_correlation_functions_mocks.py 了解如何直接使用 CPython 扩展的示例。以下是一些示例

from __future__ import print_function
import os.path as path
import numpy as np
import Corrfunc
from Corrfunc.theory import wp

# Setup the problem for wp
boxsize = 500.0
pimax = 40.0
nthreads = 4

# Create a fake data-set.
Npts = 100000
x = np.float32(np.random.random(Npts))
y = np.float32(np.random.random(Npts))
z = np.float32(np.random.random(Npts))
x *= boxsize
y *= boxsize
z *= boxsize

# Setup the bins
rmin = 0.1
rmax = 20.0
nbins = 20

# Create the bins
rbins = np.logspace(np.log10(0.1), np.log10(rmax), nbins + 1)

# Call wp
wp_results = wp(boxsize, pimax, nthreads, rbins, x, y, z, verbose=True, output_rpavg=True)

# Print the results
print("#############################################################################")
print("##       rmin           rmax            rpavg             wp            npairs")
print("#############################################################################")
print(wp_results)