Skip to main content

Symbolic Mode Coupling

Project description

4 1 symlens Documentation Status

This library allows one to build and evaluate arbitrary separable mode-coupling estimators. In practice, its main purpose is to provide a flat-sky lensing estimator code. More generally, one can build estimators and noise functions for convergence, magnification, shear, mixed estimators (for gradient cleaning), split-based lensing, birefringence, patchy tau, etc. and cross-covariances between these.

Instead of having to calculate by hand the separable forms of the above, one simply provides the mode-coupling and filter expressions, and a sympy-based (Mathematica-like) backend factorizes these expressions into FFT-only form (i.e., no explicit convolutions are required).

Curved sky support does not exist. Adding it is possibly non-trivial, but thoughts and ideas (and PRs!) are highly appreciated. Still, this package can serve as the backend for quick exploration of various kinds of estimators.

4.1 1.1 Dependencies

  • Python>=3.6

  • pixell

  • numpy, sympy

4.2 1.2 Installing

To install, run:

$ python install --user

4.3 1.3 Usage

See the Usage guide and the API Reference.

An important thing to remember is that by default, the code expects “physical” normalization of FFTs in pixell (not the default normalization in pixell), i.e. you should be passing in Fourier maps that come from something like

kmap = enmap.fft(imap,normalize='phys')


kmaps = enmap.map2harm(imaps,normalize='phys')

4.3.1 1.3.1 Contributing

If you have write access to this repository, please:

  1. create a new branch

  2. push your changes to that branch

  3. merge or rebase to get in sync with master

  4. submit a pull request on github

If you do not have write access, create a fork of this repository and proceed as described above.

5 2 History

5.1 2.1 0.1.0 (2019-03-06)

  • First release on PyPI.

5.2 2.2 0.3.3 (2020-07-25)

  • Better treatment of FFT factors

  • Lots of new features including bias hardening and isotropic RDN0

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

symlens-0.3.3.tar.gz (433.1 kB view hashes)

Uploaded source

Built Distribution

symlens-0.3.3-py2.py3-none-any.whl (19.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page