.github/workflows/ci.yml

@@ -3,42 +3,36 @@ name: ci
 on:
   push:
     branches:
-    - main
+      - main
   pull_request:
     branches:
-    - main
+      - main
 
 jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/setup-python@v2
-      with:
-        python-version: "3.x"
-    - uses: actions/checkout@v2
-    - name: Lint with flake8
-      run: |
-        pip install flake8
-        flake8 .
-    - name: Lint with black
-      run: |
-        pip install black
-        black --check .
+      - name: Check out repo
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+      - name: Run pre-commit
+        uses: pre-commit/action@v2.0.3
 
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
     steps:
-    - uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - uses: actions/checkout@v2
-    - name: Test with tox
-      run: |
-        pip install tox
-        tox
-    - name: Submit to codecov
-      uses: codecov/codecov-action@v1
-      if: ${{ matrix.python-version == '3.9' }}
+      - uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: actions/checkout@v2
+      - name: Test with tox
+        run: |
+          pip install tox
+          tox -- --cov scipyx --cov-report xml --cov-report term
+      - name: Submit to codecov
+        uses: codecov/codecov-action@v1
+        if: ${{ matrix.python-version == '3.9' }}

.gitignore

@@ -8,3 +8,4 @@ build/
 .cache/
 *.egg-info/
 .pytest_cache/
+.tox/

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.9.3
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/psf/black
+    rev: 21.9b0
+    hooks:
+      - id: black
+        language_version: python3
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2021 Nico Schlömer
+Copyright 2021-2022 Nico Schlömer
 
 Redistribution and use in source and binary forms, with or without modification, are
 permitted provided that the following conditions are met:

README.md

@@ -21,6 +21,7 @@ If you have a fix for a SciPy method that can't go upstream for some reason, fee
 to PR here.
 
 #### Krylov methods
+
 ```python
 import numpy as np
 import scipy.sparse
@@ -43,16 +44,19 @@ sol, info = spx.bicgstab(A, b, tol=1.0e-10)
 sol, info = spx.cgs(A, b, tol=1.0e-10)
 sol, info = spx.qmr(A, b, tol=1.0e-10)
 ```
+
 `sol` is the solution of the linear system `A @ x = b` (or `None` if no convergence),
-and `info` contains some useful data, e.g., `info.resnorms`. The methods are wrappers
-around [SciPy's iterative
+and `info` contains some useful data, e.g., `info.resnorms`. The solution `sol` and all
+callback `x` have the shape of `x0`/`b`.
+The methods are wrappers around [SciPy's iterative
 solvers](https://docs.scipy.org/doc/scipy/reference/sparse.linalg.html).
 
 Relevant issues:
- * [inconsistent number of callback calls between cg, minres](https://github.com/scipy/scipy/issues/13936)
 
+- [inconsistent number of callback calls between cg, minres](https://github.com/scipy/scipy/issues/13936)
 
 #### Optimization
+
 ```python
 import scipyx as spx
 
@@ -69,35 +73,61 @@ x0 = -3.2
 x, _ = spx.leastsq(f, x0)
 print(x)
 ```
+
 In scipyx, all intermediate values `x` and the result from a minimization `out.x` will
 have the same shape as `x0`. (In SciPy, they always have shape `(n,)`, no matter the
 input vector.)
 
 Relevant issues:
 
- * [optimization: let out.x have the same shape as
-   x0](https://github.com/scipy/scipy/issues/13869)
+- [optimization: let out.x have the same shape as
+  x0](https://github.com/scipy/scipy/issues/13869)
+
 
+#### Rolling Lagrange interpolation
 
-#### Root-finding
 ```python
+import numpy as np
 import scipyx as spx
 
 
-def f(x):
-    return x ** 2 - 2
+x = np.linspace(0.0, 1.0, 11)
+y = np.sin(7.0 * x)
+
+poly = spx.interp_rolling_lagrange(x, y, order=3)
+```
 
+Given an array of coordinates `x` and an array of values `y`, you can use scipyx to
+compute a piecewise polynomial Lagrange approximation. The `order + 1` closest
+coordinates x/y are considered for each interval.
 
-a, b = spx.bisect(f, 0.0, 5.0, tol=1.0e-12)
-a, b = spx.regula_falsi(f, 0.0, 5.0, tol=1.0e-12)
+| <img src="https://nschloe.github.io/scipyx/interp-0.svg" width="100%"> | <img src="https://nschloe.github.io/scipyx/interp-1.svg" width="100%"> | <img src="https://nschloe.github.io/scipyx/interp-2.svg" width="100%"> |
+| :--------------------------------------------------------------------: | :--------------------------------------------------------------------: | :--------------------------------------------------------------------: |
+|                                Order 0                                 |                                Order 1                                 |                                Order 2                                 |
+
+#### Jacobi elliptic functions with complex argument
+
+SciPy supports
+[Jacobi elliptic functions](https://en.wikipedia.org/wiki/Jacobi_elliptic_functions) as
+[ellipj](https://docs.scipy.org/doc/scipy/reference/generated/scipy.special.ellipj.html).
+Unfortunately, only real-valued argument `u` and parameter `m` are allowed. scipyx
+expands support to complex-valued argument `u`.
+
+```python
+import scipyx as spx
+
+u = 1.0 + 2.0j
+m = 0.8
+# sn, cn, dn, ph = scipy.special.ellipj(x, m)  # not working
+sn, cn, dn, ph = spx.ellipj(u, m)
 ```
-scipyx provides some basic nonlinear root-findings algorithms:
-[bisection](https://en.wikipedia.org/wiki/Bisection_method) and [regula
-falsi](https://en.wikipedia.org/wiki/Regula_falsi). They're not as fast-converging as
-[other methods](https://en.wikipedia.org/wiki/Newton%27s_method), but are very robust
-and work with almost any function.
 
+Relevant bug reports:
+
+- [Jacobian elliptic function with complex argument
+  #12226](https://github.com/scipy/scipy/issues/12226)
 
 ### License
+
 This software is published under the [BSD-3-Clause
 license](https://spdx.org/licenses/BSD-3-Clause.html).

justfile

@@ -0,0 +1,22 @@
+version := `python3 -c "from src.scipyx.__about__ import __version__; print(__version__)"`
+
+default:
+	@echo "\"just publish\"?"
+
+publish:
+	@if [ "$(git rev-parse --abbrev-ref HEAD)" != "main" ]; then exit 1; fi
+	gh release create "v{{version}}"
+	flit publish
+
+clean:
+	@find . | grep -E "(__pycache__|\.pyc|\.pyo$)" | xargs rm -rf
+	@rm -rf src/*.egg-info/ build/ dist/ .tox/
+
+format:
+	isort .
+	black .
+	blacken-docs README.md
+
+lint:
+	black --check .
+	flake8 .

pyproject.toml

@@ -1,3 +1,38 @@
 [build-system]
-requires = ["setuptools>=42", "wheel"]
-build-backend = "setuptools.build_meta"
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[tool.isort]
+profile = "black"
+
+[project]
+name = "scipyx"
+authors = [{name = "Nico Schlömer", email = "nico.schloemer@gmail.com"}]
+description = "SciPy fixes and extensions"
+readme = "README.md"
+license = {file = "LICENSE"}
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: BSD License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Topic :: Scientific/Engineering",
+  "Topic :: Utilities",
+]
+dynamic = ["version"]
+requires-python = ">=3.7"
+dependencies = [
+  "numpy >= 1.20.0",
+  "scipy",
+]
+
+[project.urls]
+Code = "https://github.com/nschloe/scipyx"
+Issues = "https://github.com/nschloe/scipyx/issues"
+Funding = "https://github.com/sponsors/nschloe"