search

manodeep / Corrfunc

⚡️⚡️⚡️Blazing fast correlation functions on the CPU.
https://corrfunc.readthedocs.io
MIT License
165 stars 50 forks source link

[bug reports] error in Corrfunc documentation #144

Closed dptriani closed 6 years ago

dptriani commented 6 years ago

Hi, I found these errors while walking through the "Typical Task for Computing Correlation Function:

Calculating Correlation Functions on Simulations

  1. In converting 3D pair counts into a correlation function "NameError: name 'N' is not defined"
  2. In converting (rp,π) pairs into a projected correlation function "NameError: name 'N' is not defined" "TypeError: DDrppi() missing 1 required positional argument: 'Z1'" "NameError: name 'np' is not defined"

Calculating Correlation Functions on Mock Catalogs

  1. In calculating the projected correlation function, wp(rp) "_OSError: Could not locate file /mocks/tests/data/Mr19_randomsnorthonly.rdcz.ff" on the subjected directory, there are 3 files which are: Mr19_mock_northonly.rdcz.ff Mr19_mock_northonly.rdcz.dat Mr19_centers_xyz_forVPF_rmax_10Mpc.txt
  2. Calculating the angular correlation function, ω(θ) "_OSError: Could not locate file /mocks/tests/data/Mr19_randomsnorthonly.rdcz.ff" "NameError: name 'np' is not defined" "NameError: name 'nthreads' is not defined" "_NameError: name 'randN' is not defined"
manodeep commented 6 years ago

Thanks Pipit for the bug report. Such feedback helps to improve quality of the code and the documentation :)

These examples are covered by automatic doctests and the TRAVIS build should be failing. This can only be confidently fixed after #143