Merge branch 'main' into paddy/issue-273

.github/workflows/release.yml

@@ -2,14 +2,10 @@
 name: Release
 
 on:
-  workflow_dispatch:
-    inputs:
-      target:
-        default: testpypi
-        description: Deployment target. Can be pypi or testpypi.
   release:
     types:
       - published
+  workflow_dispatch:
 
 jobs:
   dist:
@@ -55,8 +51,16 @@ jobs:
     needs: dist
     runs-on: ubuntu-latest
     environment:
-      name: publish
-      url: https://pypi.org/p/glass
+      name: >-
+        ${{ (github.event_name == 'release' &&
+         github.event.action == 'published') &&
+         'publish' ||
+         'test-publish' }}
+      url: >-
+        ${{ (github.event_name == 'release' &&
+         github.event.action == 'published') &&
+         'https://pypi.org/project/glass' ||
+         'https://test.pypi.org/project/glass' }}
     permissions:
       id-token: write
     steps:
@@ -71,12 +75,11 @@ jobs:
 
       - name: Publish to PyPI
         if: >-
-          github.event.inputs.target == 'pypi' || (github.event_name ==
-          'release' && github.event.action == 'published')
+          github.event_name == 'release' && github.event.action == 'published'
         uses: pypa/gh-action-pypi-publish@release/v1
 
       - name: Publish to TestPyPI
-        if: github.event.inputs.target == 'testpypi'
+        if: github.event_name == 'workflow_dispatch'
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           repository-url: https://test.pypi.org/legacy/

glass/lensing.py

@@ -45,6 +45,117 @@
     from glass.shells import RadialWindow
 
 
+@typing.overload
+def from_convergence(
+    kappa: npt.NDArray[np.float64],
+    lmax: int | None = None,
+    *,
+    potential: typing.Literal[True] = True,
+    deflection: typing.Literal[False] = False,
+    shear: typing.Literal[False] = False,
+    discretized: bool = True,
+) -> tuple[npt.NDArray[np.float64]]:
+    # returns psi
+    ...
+
+
+@typing.overload
+def from_convergence(
+    kappa: npt.NDArray[np.float64],
+    lmax: int | None = None,
+    *,
+    potential: typing.Literal[False] = False,
+    deflection: typing.Literal[True] = True,
+    shear: typing.Literal[False] = False,
+    discretized: bool = True,
+) -> tuple[npt.NDArray[np.complex128]]:
+    # returns alpha
+    ...
+
+
+@typing.overload
+def from_convergence(
+    kappa: npt.NDArray[np.float64],
+    lmax: int | None = None,
+    *,
+    potential: typing.Literal[False] = False,
+    deflection: typing.Literal[False] = False,
+    shear: typing.Literal[True] = True,
+    discretized: bool = True,
+) -> tuple[npt.NDArray[np.complex128]]:
+    # returns gamma
+    ...
+
+
+@typing.overload
+def from_convergence(
+    kappa: npt.NDArray[np.float64],
+    lmax: int | None = None,
+    *,
+    potential: typing.Literal[True] = True,
+    deflection: typing.Literal[True] = True,
+    shear: typing.Literal[False] = False,
+    discretized: bool = True,
+) -> tuple[
+    npt.NDArray[np.float64],
+    npt.NDArray[np.complex128],
+]:
+    # returns psi, alpha
+    ...
+
+
+@typing.overload
+def from_convergence(
+    kappa: npt.NDArray[np.float64],
+    lmax: int | None = None,
+    *,
+    potential: typing.Literal[True] = True,
+    deflection: typing.Literal[False] = False,
+    shear: typing.Literal[True] = True,
+    discretized: bool = True,
+) -> tuple[
+    npt.NDArray[np.float64],
+    npt.NDArray[np.complex128],
+]:
+    # returns psi, gamma
+    ...
+
+
+@typing.overload
+def from_convergence(
+    kappa: npt.NDArray[np.float64],
+    lmax: int | None = None,
+    *,
+    potential: typing.Literal[False] = False,
+    deflection: typing.Literal[True] = True,
+    shear: typing.Literal[True] = True,
+    discretized: bool = True,
+) -> tuple[
+    npt.NDArray[np.complex128],
+    npt.NDArray[np.complex128],
+]:
+    # returns alpha, gamma
+    ...
+
+
+@typing.overload
+def from_convergence(
+    kappa: npt.NDArray[np.float64],
+    lmax: int | None = None,
+    *,
+    potential: typing.Literal[True] = True,
+    deflection: typing.Literal[True] = True,
+    shear: typing.Literal[True] = True,
+    discretized: bool = True,
+) -> tuple[
+    npt.NDArray[np.float64],
+    npt.NDArray[np.complex128],
+    npt.NDArray[np.complex128],
+]:
+    # returns psi, alpha, gamma
+    ...
+
+
 def from_convergence(  # noqa: PLR0913
     kappa: npt.NDArray[np.float64],
     lmax: int | None = None,
@@ -53,7 +164,7 @@ def from_convergence(  # noqa: PLR0913
     deflection: bool = False,
     shear: bool = False,
     discretized: bool = True,
-) -> tuple[npt.NDArray[np.float64], ...]:
+) -> tuple[npt.NDArray[np.float64] | npt.NDArray[np.complex128], ...]:
     r"""
     Compute other weak lensing maps from the convergence.
 
@@ -175,7 +286,7 @@ def from_convergence(  # noqa: PLR0913
     ell = np.arange(lmax + 1)
 
     # this tuple will be returned
-    results: tuple[npt.NDArray[np.float64], ...] = ()
+    results: tuple[npt.NDArray[np.float64] | npt.NDArray[np.complex128], ...] = ()
 
     # convert convergence to potential
     fl = np.divide(-2, ell * (ell + 1), where=(ell > 0), out=np.zeros(lmax + 1))

glass/observations.py

@@ -89,7 +89,7 @@ def gaussian_nz(
     mean: float | npt.NDArray[np.float64],
     sigma: float | npt.NDArray[np.float64],
     *,
-    norm: npt.NDArray[np.float64] | None = None,
+    norm: float | npt.NDArray[np.float64] | None = None,
 ) -> npt.NDArray[np.float64]:
     """
     Gaussian redshift distribution.
@@ -130,11 +130,11 @@ def gaussian_nz(
 
 def smail_nz(
     z: npt.NDArray[np.float64],
-    z_mode: npt.NDArray[np.float64],
-    alpha: npt.NDArray[np.float64],
-    beta: npt.NDArray[np.float64],
+    z_mode: float | npt.NDArray[np.float64],
+    alpha: float | npt.NDArray[np.float64],
+    beta: float | npt.NDArray[np.float64],
     *,
-    norm: npt.NDArray[np.float64] | None = None,
+    norm: float | npt.NDArray[np.float64] | None = None,
 ) -> npt.NDArray[np.float64]:
     r"""
     Redshift distribution following Smail et al. (1994).