Skip to main content

A Python implementation of Chebfun

Project description

ChebPy

A Python implementation of Chebfun

License: BSD-3-Clause Python versions PyPI - Version

Github Linux MAC OS Code style: ruff uv Hatch project CodeFactor

CI MARIMO DEVCONTAINER

Open in GitHub Codespaces

🔬 Numerical computing with Chebyshev series approximations

Symbolic-numeric computation with functions

ChebPy is a Python implementation of Chebfun, bringing the power of Chebyshev polynomial approximations to Python. It allows you to work with functions as first-class objects, performing operations like differentiation, integration, and root-finding with machine precision accuracy.

Table of Contents


✨ Features

Work with functions as easily as numbers

  • 🔢 Function Approximation: Automatic Chebyshev polynomial approximation of smooth functions
  • 📐 Calculus Operations: Differentiation, integration, and root-finding with machine precision
  • 📊 Plotting: Beautiful function visualizations with matplotlib integration
  • 🧮 Arithmetic: Add, subtract, multiply, and compose functions naturally
  • 🎯 Adaptive: Automatically determines optimal polynomial degree for given tolerance
  • 🔗 Interoperability: Works seamlessly with NumPy and SciPy ecosystems

📥 Installation

Using pip (recommended)

pip install chebpy

From source (development)

git clone https://github.com/chebpy/chebpy.git
cd chebpy
pip install -e .

Note: Use -e flag for editable installation during development

🛠️ Development

For contributors and advanced users

ChebPy uses modern Python development tools for a smooth developer experience:

# 📦 Install development dependencies
make install

# 🧪 Run tests with coverage
make test

# ✨ Format and lint code
make fmt
make lint

# 📓 Start interactive notebooks
make marimo

# 🔍 View test coverage report
make coverage

Development Tools

  • Testing: pytest with coverage reporting
  • Formatting: ruff for code formatting and linting
  • Notebooks: marimo for interactive development
  • Task Management: Taskfile for build automation

Quick Start

ChebPy Example

This figure was generated with the following simple ChebPy code:

import numpy as np
from chebpy import chebfun

# Create functions as chebfuns on interval [0, 10]
f = chebfun(lambda x: np.sin(x**2) + np.sin(x)**2, [0, 10])
g = chebfun(lambda x: np.exp(-(x-5)**2/10), [0, 10])

# Find intersection points
roots = (f - g).roots()

# Plot both functions and mark intersections
ax = f.plot(label='f(x) = sin(x²) + sin²(x)')
g.plot(ax=ax, label='g(x) = exp(-(x-5)²/10)')
ax.plot(roots, f(roots), 'ro', markersize=8, label='Intersections')
ax.legend()
ax.grid(True, alpha=0.3)

More Examples

# Differentiation and integration
f = chebfun(lambda x: np.exp(x) * np.sin(x), [-1, 1])
df_dx = f.diff()          # Derivative
integral = f.sum()        # Definite integral

# Root finding
g = chebfun(lambda x: x**3 - 2*x - 5, [-3, 3])
roots = g.roots()         # All roots in the domain

Convolution

Convolve two functions to produce a new Chebfun on the summed domain:

from chebpy import chebfun
import numpy as np

f = chebfun(lambda x: np.exp(-x**2), [-1, 1])
g = chebfun(lambda x: np.where(np.abs(x) < 0.5, 1.0, 0.0), [-1, 1])

h = f.conv(g)        # h(x) = ∫ f(t) g(x−t) dt, a Chebfun on [−2, 2]
h.plot()

Quasimatrices

Stack functions as columns of an ∞×n matrix and use continuous linear algebra — QR, SVD, least-squares:

from chebpy import Quasimatrix, chebfun

x = chebfun("x")
A = Quasimatrix([1, x, x**2, x**3, x**4, x**5])

Q, R = A.qr()             # QR factorisation → Legendre polynomials
U, S, V = A.svd()         # Singular value decomposition

f = chebfun(lambda t: np.exp(t) * np.sin(6 * t), [-1, 1])
c = A.solve(f)            # Least-squares polynomial fit
f_approx = A @ c          # Reconstruct as a Chebfun

Gaussian Process Regression

Fit a GP to scattered data and get the posterior mean and variance back as Chebfuns — ready for differentiation, integration, and root-finding:

from chebpy import gpr
import numpy as np

rng = np.random.default_rng(1)
x_obs = np.sort(-2 + 4 * rng.random(10))
y_obs = np.sin(np.exp(x_obs))

f_mean, f_var = gpr(x_obs, y_obs, domain=[-2, 2])

f_mean.plot()                     # Posterior mean (a Chebfun)
extrema = f_mean.diff().roots()   # Local extrema via calculus
integral = f_mean.sum()           # Definite integral


Documentation

  • 🚀 Codespaces: Try ChebPy in your browser
  • 📚 Documentation: Full documentation, user guide, and API reference

📄 License

ChebPy is licensed under the 3-Clause BSD License.

📜 See the full license in the LICENSE.rst file.


👥 Contributing

We welcome contributions! 🎉

Whether you're fixing bugs, adding features, or improving documentation, your help makes ChebPy better for everyone.

Quick Start for Contributors

  1. 🍴 Fork the repository
  2. 🌿 Create your feature branch
    git checkout -b feature/amazing-feature
    
  3. Make your changes and add tests
  4. 🧪 Test your changes
    make test
    
  5. 📝 Commit your changes
    git commit -m 'Add amazing feature'
    
  6. 🚀 Push to your branch
    git push origin feature/amazing-feature
    
  7. 🎯 Open a Pull Request

Resources

Acknowledgments 🙏


Made with ❤️ by the ChebPy community

If you find ChebPy useful, please consider giving it a star!

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

chebfun-0.8.0.tar.gz (674.0 kB view details)

Uploaded Source

Built Distribution

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

chebfun-0.8.0-py3-none-any.whl (76.8 kB view details)

Uploaded Python 3

File details

Details for the file chebfun-0.8.0.tar.gz.

File metadata

  • Download URL: chebfun-0.8.0.tar.gz
  • Upload date:
  • Size: 674.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for chebfun-0.8.0.tar.gz
Algorithm Hash digest
SHA256 f1c600c602727aaabb0c19da5a76b9cf399162bb127acf9a30041d7bd96e313e
MD5 b9aa43fa53b0dba743b95b7f2393e36f
BLAKE2b-256 a355bb18a7c08f1730c7922a45275f0f4949cdddf4116f957f551c7bf218e877

See more details on using hashes here.

Provenance

The following attestation bundles were made for chebfun-0.8.0.tar.gz:

Publisher: rhiza_release.yml on chebpy/chebpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file chebfun-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: chebfun-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 76.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for chebfun-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4ea849a25cf32f8b567023a38b8520e1b08c267e6e8ea31d339cb15209febc94
MD5 040969540a806f6a46abdc766b5469c2
BLAKE2b-256 60b34015ad2b9b0f1665bda4730e6ab8ec50f578bc354af01d55b0d402fbd0f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for chebfun-0.8.0-py3-none-any.whl:

Publisher: rhiza_release.yml on chebpy/chebpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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