pysolverkit 0.1.0__tar.gz

pysolverkit-0.1.0/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: pysolverkit
+Version: 0.1.0
+Summary: A Python library of numerical methods for root finding, interpolation, integration, ODEs, and linear systems
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# PySolverKit
+
+[![Tests](https://github.com/mrigankpawagi/PySolverKit/actions/workflows/tests.yml/badge.svg)](https://github.com/mrigankpawagi/PySolverKit/actions/workflows/tests.yml)
+![Python](https://img.shields.io/badge/python-3.10%2B-blue)
+
+A compact Python library that brings classical numerical methods to life — root finding, interpolation, differentiation, integration, ODE solvers, linear systems, and 2D FEM for Poisson problems.
+
+## Features
+
+- **Function arithmetic** — add, subtract, multiply, and compose built-in function types (`Polynomial`, `Sin`, `Cos`, `Tan`, `Exponent`, `Log`) with plain Python operators
+- **Root finding** — bisection, Newton-Raphson, secant, Regula Falsi, and modified Newton methods
+- **Interpolation** — Lagrange and Newton divided-difference forms (forward/backward difference tables included)
+- **Differentiation** — forward, backward, and central finite-difference schemes; set an exact derivative for Newton-type solvers
+- **Integration** — rectangular, midpoint, trapezoidal, Simpson's, and Gauss-Legendre quadrature
+- **ODE solvers** — Euler, Runge-Kutta (orders 1–4), Taylor series, trapezoidal, Adams-Bashforth/Moulton, and predictor-corrector methods for first-order IVPs; shooting and finite-difference methods for second-order BVPs
+- **Linear algebra** — `Vector` and `Matrix` with arithmetic operations, and `LinearSystem` with Gaussian elimination and Gauss-Jacobi/Seidel iterative solvers
+- **2D FEM** — `FEM2D` for Poisson equations on rectangular domains with Dirichlet boundary conditions
+
+## Quick start
+
+```python
+import math
+from pysolverkit import Polynomial, Sin, RootFindingMethod, IntegrationMethod
+
+# Root finding
+f = Polynomial(-6, 14, -7, 1)   # x³ − 7x² + 14x − 6
+root = f.root(RootFindingMethod.BISECTION, a=0, b=1, TOLERANCE=1e-6)
+
+# Integration
+g = Sin(Polynomial(0, 1))       # sin(x)
+area = g.integrate(0, math.pi, method=IntegrationMethod.SIMPSON, n=100)
+```
+
+## Documentation
+
+Full API reference, detailed usage examples, and a method selector reference are in **[`docs/README.md`](docs/README.md)**.
+
+## Running tests
+
+```bash
+python3 -m unittest discover -s tests -v
+```
+
+## Contributing
+
+Contributions are welcome! To get started:
+
+1. Fork the repository and create a feature branch.
+2. Add or update tests in `tests/tests.py` for any new behaviour.
+3. Ensure all tests pass: `python3 -m unittest discover -s tests -v`
+4. Open a pull request with a clear description of the change.

pysolverkit-0.1.0/README.md

@@ -0,0 +1,51 @@
+# PySolverKit
+
+[![Tests](https://github.com/mrigankpawagi/PySolverKit/actions/workflows/tests.yml/badge.svg)](https://github.com/mrigankpawagi/PySolverKit/actions/workflows/tests.yml)
+![Python](https://img.shields.io/badge/python-3.10%2B-blue)
+
+A compact Python library that brings classical numerical methods to life — root finding, interpolation, differentiation, integration, ODE solvers, linear systems, and 2D FEM for Poisson problems.
+
+## Features
+
+- **Function arithmetic** — add, subtract, multiply, and compose built-in function types (`Polynomial`, `Sin`, `Cos`, `Tan`, `Exponent`, `Log`) with plain Python operators
+- **Root finding** — bisection, Newton-Raphson, secant, Regula Falsi, and modified Newton methods
+- **Interpolation** — Lagrange and Newton divided-difference forms (forward/backward difference tables included)
+- **Differentiation** — forward, backward, and central finite-difference schemes; set an exact derivative for Newton-type solvers
+- **Integration** — rectangular, midpoint, trapezoidal, Simpson's, and Gauss-Legendre quadrature
+- **ODE solvers** — Euler, Runge-Kutta (orders 1–4), Taylor series, trapezoidal, Adams-Bashforth/Moulton, and predictor-corrector methods for first-order IVPs; shooting and finite-difference methods for second-order BVPs
+- **Linear algebra** — `Vector` and `Matrix` with arithmetic operations, and `LinearSystem` with Gaussian elimination and Gauss-Jacobi/Seidel iterative solvers
+- **2D FEM** — `FEM2D` for Poisson equations on rectangular domains with Dirichlet boundary conditions
+
+## Quick start
+
+```python
+import math
+from pysolverkit import Polynomial, Sin, RootFindingMethod, IntegrationMethod
+
+# Root finding
+f = Polynomial(-6, 14, -7, 1)   # x³ − 7x² + 14x − 6
+root = f.root(RootFindingMethod.BISECTION, a=0, b=1, TOLERANCE=1e-6)
+
+# Integration
+g = Sin(Polynomial(0, 1))       # sin(x)
+area = g.integrate(0, math.pi, method=IntegrationMethod.SIMPSON, n=100)
+```
+
+## Documentation
+
+Full API reference, detailed usage examples, and a method selector reference are in **[`docs/README.md`](docs/README.md)**.
+
+## Running tests
+
+```bash
+python3 -m unittest discover -s tests -v
+```
+
+## Contributing
+
+Contributions are welcome! To get started:
+
+1. Fork the repository and create a feature branch.
+2. Add or update tests in `tests/tests.py` for any new behaviour.
+3. Ensure all tests pass: `python3 -m unittest discover -s tests -v`
+4. Open a pull request with a clear description of the change.

pysolverkit-0.1.0/pyproject.toml

@@ -0,0 +1,10 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pysolverkit"
+version = "0.1.0"
+description = "A Python library of numerical methods for root finding, interpolation, integration, ODEs, and linear systems"
+readme = "README.md"
+requires-python = ">=3.10"

pysolverkit-0.1.0/pysolverkit/__init__.py

@@ -0,0 +1,70 @@
+from .functions import (
+    Function,
+    Polynomial,
+    Exponent,
+    Sin,
+    Cos,
+    Tan,
+    Log,
+    MultiVariableFunction,
+    BivariateFunction,
+    FEM2D,
+)
+from .linalg import Vector, Matrix, LinearSystem
+from .ode import (
+    OrdinaryDifferentialEquation,
+    LinearODE,
+    FirstOrderLinearODE,
+    SecondOrderLinearODE_BVP,
+    SecondOrderODE_IVP,
+    SecondOrderODE_BVP,
+)
+from .util import Util
+from .enums import (
+    DifferentiationMethod,
+    IntegrationMethod,
+    RootFindingMethod,
+    InterpolationMethod,
+    InterpolationForm,
+    ODEMethod,
+    BVPMethod,
+    NonlinearBVPMethod,
+    LinearSolverMethod,
+)
+
+__all__ = [
+    # Functions
+    "Function",
+    "Polynomial",
+    "Exponent",
+    "Sin",
+    "Cos",
+    "Tan",
+    "Log",
+    "MultiVariableFunction",
+    "BivariateFunction",
+    "FEM2D",
+    # Linear algebra
+    "Vector",
+    "Matrix",
+    "LinearSystem",
+    # ODEs
+    "OrdinaryDifferentialEquation",
+    "LinearODE",
+    "FirstOrderLinearODE",
+    "SecondOrderLinearODE_BVP",
+    "SecondOrderODE_IVP",
+    "SecondOrderODE_BVP",
+    # Utilities
+    "Util",
+    # Enums
+    "DifferentiationMethod",
+    "IntegrationMethod",
+    "RootFindingMethod",
+    "InterpolationMethod",
+    "InterpolationForm",
+    "ODEMethod",
+    "BVPMethod",
+    "NonlinearBVPMethod",
+    "LinearSolverMethod",
+]

pysolverkit-0.1.0/pysolverkit/enums.py

@@ -0,0 +1,91 @@
+from enum import Enum
+
+
+class DifferentiationMethod(Enum):
+    """Numerical differentiation method."""
+
+    FORWARD = "forward"
+    BACKWARD = "backward"
+    CENTRAL = "central"
+
+
+class IntegrationMethod(Enum):
+    """Numerical integration (quadrature) method."""
+
+    RECTANGULAR = "rectangular"
+    MIDPOINT = "midpoint"
+    TRAPEZOIDAL = "trapezoidal"
+    SIMPSON = "simpson"
+    GAUSS = "gauss"
+
+
+class RootFindingMethod(Enum):
+    """Root-finding method for scalar equations."""
+
+    BISECTION = "bisection"
+    NEWTON = "newton"
+    MODIFIED_NEWTON = "modified_newton"
+    SECANT = "secant"
+    REGULA_FALSI = "regula_falsi"
+
+
+class InterpolationMethod(Enum):
+    """Polynomial interpolation method."""
+
+    LAGRANGE = "lagrange"
+    NEWTON = "newton"
+
+
+class InterpolationForm(Enum):
+    """Form of Newton interpolating polynomial."""
+
+    STANDARD = "standard"
+    FORWARD_DIFF = "forward_diff"
+    BACKWARD_DIFF = "backward_diff"
+
+
+class ODEMethod(Enum):
+    """Numerical solver for first-order ODE initial value problems."""
+
+    EULER = "euler"
+    RUNGE_KUTTA = "runge-kutta"
+    TAYLOR = "taylor"
+    TRAPEZOIDAL = "trapezoidal"
+    ADAMS_BASHFORTH = "adam-bashforth"
+    ADAMS_MOULTON = "adam-moulton"
+    PREDICTOR_CORRECTOR = "predictor-corrector"
+
+
+class BVPMethod(Enum):
+    """Solver for second-order linear boundary value problems."""
+
+    SHOOTING = "shooting"
+    FINITE_DIFFERENCE = "finite_difference"
+
+
+class NonlinearBVPMethod(Enum):
+    """Solver for second-order nonlinear boundary value problems."""
+
+    SHOOTING_NEWTON = "shooting_newton"
+    FINITE_DIFFERENCE = "finite_difference"
+
+
+class LinearSolverMethod(Enum):
+    """Solver for systems of linear equations."""
+
+    GAUSS_ELIMINATION = "gauss_elimination"
+    GAUSS_JACOBI = "gauss_jacobi"
+    GAUSS_SEIDEL = "gauss_seidel"
+
+
+__all__ = [
+    "DifferentiationMethod",
+    "IntegrationMethod",
+    "RootFindingMethod",
+    "InterpolationMethod",
+    "InterpolationForm",
+    "ODEMethod",
+    "BVPMethod",
+    "NonlinearBVPMethod",
+    "LinearSolverMethod",
+]

pysolverkit-0.1.0/pysolverkit/functions/__init__.py

@@ -0,0 +1,17 @@
+from .base import Function
+from .elementary import Polynomial, Exponent, Sin, Cos, Tan, Log
+from .multivariate import MultiVariableFunction, BivariateFunction
+from .fem2d import FEM2D
+
+__all__ = [
+    "Function",
+    "Polynomial",
+    "Exponent",
+    "Sin",
+    "Cos",
+    "Tan",
+    "Log",
+    "MultiVariableFunction",
+    "BivariateFunction",
+    "FEM2D",
+]