pysuperfab 0.5.16

Python wrapper for SphericalFourierBesselDecompositions.jl

SuperFaB

SuperFaB is a code for cosmological spherical Fourier-Bessel (SFB) analysis. The details of the code are presented in 2102.10079.

The name of this package is SphericalFourierBesselDecompositions.jl.

For installation instructions and a tutorial, see the Documentation.

pySuperFaB Python wrapper

This is a simple Python wrapper for SphericalFourierBesselDecompositions.jl.

Installation

pip install pysuperfab

The only dependency (from a Python perspective) is juliacall, which is available in conda as pyjuliacall.

Usage

You can use this as any other Python package. Under the hood it uses JuliaCall, which on first import will automatically download Julia if you don't already have it. It will also then download the SphericalFourierBesselDecompositions.jl Julia package.

Use pySuperFaB like so:

from pysuperfab import SFB

kmin = 0.05
rmin = 0.0
rmax = 2300.0
amodes = SFB.AnlmModes(kmin, rmin, rmax)

That should start looking really familiar from the SphericalFourierBesselDecompositions.jl documentation.

How to make a release

To avoid the awkwardness that the python CI cannot pass until the Julia package is registered, I recommend to do this in two steps: First do the Julia release, then the Python release.

1. Update version:

   a. Edit version field in Project.toml.

   b. Edit version field in pysuperfab/juliapkg.json.

   c. Edit version field in pyproject.toml.

   d. Commit version updates. There is an awkwardness here: CI cannot pass for the python package until the Julia package has been registered.

2. Julia release: comment with @JuliaRegistrator register() on that commit. This will publicize the package in the Julia General registry.

3. Build and upload Python package:

   a. python -m build

   b. python -m twine upload dist/*