EllipPy Documentation#
EllipPy is an elliptic integral library for Python, powered by Rust. All functions support numpy and parallelization. EllipPy features high accuracy and performance. For more details on testing and benchmarks, please refer to [Ellip](p-sira/ellip).
Quick Start#
from ellippy import *
import numpy as np
ellipk(m=np.array([0.1, 0.2, 0.3, 0.4, 0.5])) # [1.61244135 1.6596236 1.71388945 1.77751937 1.85407468]
ellippiinc(n=0.1, phi=np.pi / 4, m=0.25) # 0.1003043379500434
cel(kc=0.5, p=0.1, a=1.0, b=-1.0) # -5.2310275365518795
elliprf(x=[0.1, 0.2, 0.3], y=[0.2, 0.4, 0.8], z=[0.3, 0.5, 0.7]) # [2.29880489 1.68455225 1.32157804]
jacobi_zeta(phi=np.pi / 3, m=0.5) # 0.13272240254017148
To install EllipPy, use your preferred package manager:
pip install ellippy
uv add ellippy
Submodules#
Elliptic integral functions in Legendre's form. |
|
Elliptic integral functions in Bulirsch's form. |
|
Elliptic integral functions in Carlson's form. |
|
Miscellaneous functions related to elliptic integrals. |
Legendre’s Integrals#
ellippy.legendre
Elliptic integral functions in Legendre’s form.
Complete Elliptic Integrals#
Functions
Incomplete Elliptic Integrals#
Functions
Computes incomplete elliptic integral of the first kind F(φ | m). |
|
Computes incomplete elliptic integral of the second kind E(φ | m). |
|
Computes incomplete elliptic integral of the third kind Π(n; φ | m). |
|
Computes incomplete elliptic integral of the third kind using the Bulirsch algorithm. |
|
Computes incomplete elliptic integral of Legendre's type D(φ | m). |
Bulirsch’s Integrals#
ellippy.bulirsch
Elliptic integral functions in Bulirsch’s form.
Functions
Computes general complete elliptic integral in Bulirsch form |
|
Computes Bulirsch complete integral of the first kind |
|
Computes Bulirsch complete integral of the second kind |
|
Computes Bulirsch incomplete integral of the first kind |
|
Computes Bulirsch incomplete integral of the second kind |
|
Computes Bulirsch incomplete integral of the third kind |
Carlson’s Symmetric Integrals#
ellippy.carlson
Elliptic integral functions in Carlson’s form.
Functions
Computes Carlson degenerate integral RC. |
|
Computes Carlson degenerate integral RD. |
|
Computes Carlson symmetric integral RF. |
|
Computes Carlson symmetric integral RG. |
|
Computes Carlson symmetric integral RJ. |
Miscellaneous Functions#
ellippy.misc
Miscellaneous functions related to elliptic integrals.
Functions
Computes Heuman Lambda function Λ₀(φ | m). |
|
Computes Jacobi Zeta function Z(φ | m). |