Corrfunc

=================

**Breaking Changes**
---------------------
- Package will be renamed to ``corrfunc`` from ``Corrfunc``

New features
------------
- conda installable package
- GPU version

==================
Final release of the 2.5.x series and last Corrfunc version to support ``python2``

Infrastructure
--------------
- Updated minimum numpy to ``1.20`` [324]
- No longer testing on ``python2`` [324]

==================

Enhancements
------------
- Simplified and faster ``FALLBACK`` kernels [303]

Infrastructure
--------------
- Fix ``python_requires`` in setup.py [302]
- Automatic uploads of new releases to PyPI [305]
- Added dependabot for automatic dependency updates in GitHub Actions [306, 307, 308]

==================

Enhancements
------------
- Corrfunc now compiles and runs on Apple M1/M2 cpus (using the `FALLBACK` kernels) [295]

Changes
-------
- Python >= 3.7 and numpy >= 1.16 are required for python extensions [291]

Enhancements
------------
- Warn about loss of precision for float32 calculations involving small ``theta`` in ``DDtheta_mocks`` and large ``mu`` in ``DDsmu_mocks`` [299]

================

Enhancements
------------
- Allow user to specify periodicity and box size per dimension [276]
- Allow larger Rmax (up to half the boxsize) [277]

Changes
-------
- Add Corrfunc/tests.py to CI testing [260]
- Migrate doctests to Python 3.8 [261]
- Migrate Python tests to pytest [265]

Fixes
-----
- Add additional check to tell if it's safe to redirect stdout/err [270]
- Check and fix ``z`` vs ``cz`` in ``DDrppi_mocks`` and ``DDsmu_mocks`` only if comoving distance flag is not set [275]
- Update GNU assembler bug detection [278]
- Fix installation instructions and update README.rst [285]
- Remove mistaken references to "projected" correlation function in docs [289]

==================
This release adds the ``boxsize`` parameter to the command line interfaces and
requires the user to specify the box size in the Python interfaces to the periodic
theory functions. It also contains a number of performance, code-quality, and
user-experience improvements.

**Breaking Changes**
--------------------
- Require user to specify ``boxsize`` rather than automatically detect particle
extent in periodic theory boxes. Applies to Python, command line, and C API.
The order of some Python keyword args has also changed. [199]

Enhancements
------------
- In the theoretical VPF calculation (``theory.vpf``), the total volume of the random spheres can now exceed the volume of the sample [238]
- Gridlink (the binning of particles into cells) now uses a parallel algorithm for the theory module [239]
- Add detection of known-bad Cray hugepages library at NERSC [246]
- Replace ``np.float`` with ``np.float64`` to fix numpy 1.20 deprecation [250]
- Test Numpy versions as old as 1.14 and recent as 1.20 [251]
- Add lscpu and preprocessor defs to CI output [259]

Bug fixes
---------
- Fix Python reference leak to results struct [229]
- Fix parsing error when ``periodic=False`` and ``boxsize`` not given in the theory module [257]