3DEX/README at master · ixkael/3DEX · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
===================
 3DEX version 1.0
===================
Paper : http://arxiv.org/abs/1111.3591

3DEX is a Fortran/CXX package providing programs and functions
to perform fast Fourier-Bessel decomposition of 3D fields.

🆕 PYTHON VERSION NOW AVAILABLE!
-------------------
A modern Python implementation (py3dex v2.0) is now available.
See README_PYTHON.md for installation and usage.

Quick install: pip install -e .
Documentation: README_PYTHON.md, MIGRATION.md

The Python version provides:
- Modern Python API with type hints
- Same mathematical algorithms as Fortran
- CLI tools compatible with original
- Comprehensive tests and validation

For new projects, we recommend using the Python version.
For existing Fortran workflows, see MIGRATION.md for transition guide.

It is distributed in the hope that it will be useful, but without
any warranty. See the CeCILL License for more details.

Please contact the authors if you have any question,
demand or proposal of new features.

AUTHORS
-------------------
 Boris Leistedt (boris.leistedt@gmail.com)
 François Lanusse (francois.lanusse@gmail.com)

REQUIREMENTS
-------------------
 Working C, Cxx, MPI and Fortran compilers
   For example : cc, cxx, mpicxx, gfortran.
 CFITSIO  (export CFITSIO=...)
 BLAS     (export BLAS=...)
 LAPACK   (export LAPACK=...)
 HEALPIX  (export HEALPIX=...)

INSTALLATION - HEALPIX-LIKE
-------------------
 Please run the ./configure command
 and answer the questions.
 It will edit the 'Makefile'
 Then, run 'make' as usual
 'make clean' to delete .o files
 'make tidy' and 'make distclean' to uninstall

INSTALLATION WITH CMAKE
-------------------
  Make sure you have exported the variables
  CFITSIO, BLAS, LAPACK and HEALPIX in your PATH.
  Then just run the script './CMakeInstall'
  In case you want to clean, the Makefile is located
  in the build/ directory ('make clean', 'make tidy').

NOTE
-------------------
  3DEX is under CeCILL license, and any user must cite
  the source and the ArXiV paper http://arxiv.org/abs/1111.3591.
  The library architecture and the installation scripts
  are directly inspired by the HEALPix package,
  which is under GPL License.

RECOMMENDATIONS FOR USE
-------------------


AVAILABLE FEATURES
-------------------
 > survey2almn
    Fourier-Bessel decomposition from a raw survey/sample (normal mode)
    Test:
    bin/survey2almn res/horizon_005_60k.txt out/almn.fits out/cln.fits 20 20 256 2000.0

 > survey2almn_lm
    Fourier-Bessel decomposition from a raw survey/sample (slower, but low-memory requirements. Suitable for Nside>1024)
    Test:
    bin/survey2almn res/horizon_005_60k.txt out/almn.fits out/cln.fits 20 20 256 2000.0

 > survey2almn_interactive
    Interactive Fourier-Bessel decomposition (with redshift to distance conversion using fiducial)
    Test:
    bin/survey2almn_interactive res/parameters.txt
    (and just type test/2mrs30.out)

 > almn2rmap
    Extract FB decomposition from .fits file and reconstructs the smoothed field at given distance
    Test:
    bin/almnfile2rmap out/almn.fits out/map.fits 400.0 256 10 10 2000.0

 > survey2almn_cxx
    You need to download the QLN table here : https://files.me.com/vladphotograph/m0krmb
    And store it in the res/ directory.
    Test:
    bin/survey2almn_cxx res/qlnTable_2000_3000.fits res/params.txt out/almn.fits 256 2000 20 20 20

 > survey2almn_mpi
    You need to download the QLN table here : https://files.me.com/vladphotograph/m0krmb
    And store it in the res/ directory.
    Test:
    mpirun -np 4 bin/survey2almn_mpi res/qlnTable_2000_3000.fits res/params.txt almn.fits 256 2000 15 15 16