Metadata-Version: 2.4
Name: spheroidalwavefunctions
Version: 0.1.6
Summary: Spheroidal wave functions
Keywords: prolate spheroidal wave function,backscatter,model
Author: Gavin Macaulay
License-Expression: MIT
License-File: license.txt
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Project-URL: Homepage, https://github.com/gavinmacaulay/spheroidalwavefunctions
Project-URL: Documentation, https://github.com/gavinmacaulay/spheroidalwavefunctions/blob/master/readme.md
Project-URL: Repository, https://github.com/gavinmacaulay/spheroidalwavefunctions
Requires-Python: >=3.12
Requires-Dist: numpy
Description-Content-Type: text/markdown

# Prolate spheroidal wave functions

![Static badge](https://img.shields.io/pypi/v/spheroidalwavefunctions.svg)
![Static badge](https://img.shields.io/github/license/gavinmacaulay/spheroidalwavefunctions)
[![python](https://img.shields.io/pypi/pyversions/spheroidalwavefunctions.svg?logo=python&logoColor=white)](https://pypi.org/project/https://github.com/gavinmacaulay/spheroidalwavefunctions/)

A Python module that wraps directly the `prolate_swf.f90` code at <https://github.com/MathieuandSpheroidalWaveFunctions/prolate_swf>, providing access to the subroutine
version of the prolate spheroidal wave code in that file.

Once installed in Python, the package can be used thus:

    from spheroidalwavefunctions import prolate_swf
    r = prolate_swf.profcn(c=0.5, m=0, lnum=10, x1=0.5, ioprad=2, iopang=2, iopnorm=0, arg=[0.1, 0.2])

Function calling details can be viewed via:

    print(prolate_swf.profcn.__doc__)

and further details on the function parameters are available in the [documentation](https://github.com/gavinmacaulay/spheroidalwavefunctions/blob/master/readme_original.md). A wrapper that provides a similar interface to
the spheroidal functions in scipy is available in the Utilities module of
[echoSMs](https://github.com/ices-tools-dev/echoSMs).

The original readme file, modified to work better in Markdown, is available [here](https://github.com/gavinmacaulay/spheroidalwavefunctions/blob/master/readme_original.md).

