Skip to main content

CROISSANT: Rapid spherical harmonics-based simulator of visibilities

Project description

# CROISSANT: spheriCal haRmOnics vISibility SimulAtor iN pyThon

[![codecov](https://codecov.io/gh/christianhbye/croissant/branch/main/graph/badge.svg?token=pj1hkgcazd)](https://codecov.io/gh/christianhbye/croissant)

CROISSANT is a rapid visiblity simulator in python based on spherical harmonics. Given an antenna design and a sky model, CROISSANT simulates the visbilities - that is, the perceived sky temperature.

CROISSANT uses spherical harmonics to decompose the sky and antenna beam to a set of coefficients. Since the spherical harmonics represents a complete, orthormal basis on the sphere, the visibility computation reduces nicely from a convolution to a dot product.

In frequency domain, CROISSANT uses Discrete Prolate Spheroidal Sequences as a rapid linear interpolation scheme. Being linear, this interpolation can be done directly on the spherical harmonics coefficients, avoiding redoing the most expensive part of the computation.

Moreover, the time evolution of the simulation is very natural in this representation. In the antenna reference frame, the sky rotates overhead with time. To account for this rotation, it is enough to rotate the spherical harmonics coefficients. In the right choice of coordinates (that is, one where the z-axis is aligned with the rotation axis of the earth or the moon), this rotation is simply achieved by multiplying the spherical coefficient by a phase.

> New in version 4.0.0: CROISSANT is now fully compatible with JAX, provided in the interfeace croissant.jax. Spherical harmonics transforms (built on [s2ftt](https://github.com/astro-informatics/s2fft/)), coordinate system transforms, rotations, and the simulator itself can now all be differentiated using JAX autograd.

Overall, this makes CROISSANT a very fast visibility simulator. CROISSANT can therefore be used to simulate a large combination of antenna models and sky models - allowing for the exploration of a range of propsed designs before choosing an antenna for an experiment.

## Installation For the latest release, do pip install croissant-sim (see https://pypi.org/project/croissant-sim). Git clone this repository for the newest changes (this is under activate development, do so at your own risk!).

To access the JAX features, JAX must also be installed. See the [installation guide](https://github.com/google/jax#installation).

Note that croissant is only tested up to Python 3.12. Python 3.13 and newer are not yet supported.

## Demo Jupyter Notebook: https://nbviewer.org/github/christianhbye/croissant/blob/main/notebooks/example_sim.ipynb

## Contributing Contributions are welcome - please see the [contribution guidelines](https://github.com/christianhbye/croissant/blob/add_contributing/CONTRIBUTING.md).

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

croissant_sim-4.1.1.tar.gz (18.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

croissant_sim-4.1.1-py3-none-any.whl (45.4 kB view details)

Uploaded Python 3

File details

Details for the file croissant_sim-4.1.1.tar.gz.

File metadata

  • Download URL: croissant_sim-4.1.1.tar.gz
  • Upload date:
  • Size: 18.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for croissant_sim-4.1.1.tar.gz
Algorithm Hash digest
SHA256 543660ba4dbc9d114318b2c1e268f19ab8b6fb761e0ce790bf5dae146d1c8f6d
MD5 501960a35b80455a0d8210f9af5c8661
BLAKE2b-256 2f11a3da5b44898a78098cb381473f197e1c441701ff49f7bd590650cdc2c6ca

See more details on using hashes here.

File details

Details for the file croissant_sim-4.1.1-py3-none-any.whl.

File metadata

  • Download URL: croissant_sim-4.1.1-py3-none-any.whl
  • Upload date:
  • Size: 45.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for croissant_sim-4.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e3201e1b6a957dec38453c22fafeea5e7081c46303a65144af9e10cf1f72d613
MD5 7c9a342317a7ce7ee6d8c7c2676bd128
BLAKE2b-256 87c8e68059d900e22048ce3bd099687bc03822a73c361c29feba60cd96568c49

See more details on using hashes here.

Supported by

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