splinekit 0.0.4__tar.gz

splinekit-0.0.4/.github/workflows/deploy-docs.yml

@@ -0,0 +1,44 @@
+# splinekit/.github/workflows/deploy-docs.yml
+
+name: Deploy Sphinx Documentation to GitHub Pages
+
+on:
+  push:
+    branches: [ main ]  # run on pushes to main
+
+permissions:
+  contents: read  # we only need to read this repo's contents
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Install documentation requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[docs]
+
+      - name: Build Sphinx documentation
+        run: sphinx-build docs/ docs/_build/
+
+      - name: Deploy to splinekit.github.io
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          external_repository: splinekit/splinekit.github.io
+          publish_branch: main
+          publish_dir: docs/_build

splinekit-0.0.4/.github/workflows/release.yml

@@ -0,0 +1,35 @@
+# splinekit/.github/workflows/release.yml
+
+name: Build & publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+  id-token: write  # OIDC for PyPI
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tooling
+        run: |
+          python -m pip install -U pip build
+
+      - name: Build sdist and wheel (pure Python)
+        run: python -m build  # creates dist/*.tar.gz and dist/*.whl
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

splinekit-0.0.4/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+# splinekit/.github/workflows/test.yml
+
+name: Test Library
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.11", "3.12"]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install splinekit with test extras
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[tests]
+
+      - name: Run tests
+        run: pytest

splinekit-0.0.4/.gitignore

@@ -0,0 +1,222 @@
+.DS_Store
+splinekit-env/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# macOS
+.DS_Store
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Sphinx documentation
+docs/_build/
+docs/_contents/
+docs/sg_execution_times.rst
+docs/auto_examples/
+docs/gen_modules/
+docs/notebooks_binder/
+docs/notebooks_jupyterlite/
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

splinekit-0.0.4/.virtual_documents/development/Jupyter/Untitled.ipynb

@@ -0,0 +1,102 @@
+
+
+
+
+
+
+# Load the required libraries.
+from ipywidgets import interactive
+import matplotlib.pyplot as plt
+
+import splinekit as sk # This library
+
+# Define the plot function
+def cardinal_b_spline_plot (
+    degree = 3
+):
+    # A cardinal B-spline has an infinite support but decays exponentially
+    # Here, we combine periodization and a wide margin to simplify the display effort
+    supp = sk.interval.Closed((-200, 200))
+    period = supp.diameter
+    # Construct a spline from a periodized cardinal B-spline
+    s = sk.PeriodicSpline1D.periodized_cardinal_b_spline(
+        period = int(period),
+        degree = degree
+    )
+    # Plot the cardinal B-spline
+    s.plot(
+        plt.subplots(),
+        plotdomain = sk.interval.Closed((-8, 8)),
+        plotrange = sk.interval.Closed((-0.25, 1.05)),
+        plotpoints = 200 + 1
+    )
+
+# Interact with the degree
+interactive(cardinal_b_spline_plot, degree = (0, 30))
+
+
+
+
+
+# Load the required libraries.
+from ipywidgets import interactive
+import math
+import matplotlib.pyplot as plt
+import numpy as np
+
+import splinekit as sk # This library
+
+# Define the plot function
+def cardinal_b_spline_as_sinc_plot (
+    degree = 3
+):
+    # Location of the samples
+    abscissa = np.linspace(-15, 15, num = 200 + 1, dtype = float)
+    # Sinc data
+    def sinc (
+        x
+    ):
+        if math.isclose(
+            0,
+            x,
+            rel_tol = math.sqrt(math.ulp(1.0)),
+            abs_tol = math.sqrt(math.ulp(1.0))
+        ):
+            return 1
+        return math.sin(math.pi * x) / (math.pi * x)
+    sinc_data = np.array([sinc(x) for x in abscissa], dtype = float)
+    # Cardinal B-spline
+    spline_data = np.array(
+        [sk.cardinal_b_spline(x, degree) for x in abscissa],
+        dtype = float
+        
+    )
+
+    # Spline plot
+    plt.subplot(211)
+    plt.xlim(-15.025, 15.025)
+    plt.ylim(-0.25, 1.05)
+    ax = plt.gca()
+    ax.spines.right.set_visible(False)
+    ax.spines.top.set_visible(False)
+    plt.plot(abscissa, sinc_data, "-C2", linewidth = 0.5)
+    plt.plot(abscissa, spline_data, "-C0")
+
+    # Difference plot
+    plt.subplot(212)
+    plt.xlim(-15.025, 15.025)
+    plt.ylim(-0.2, 0.2)
+    ax = plt.gca()
+    ax.spines.right.set_visible(False)
+    ax.spines.top.set_visible(False)
+    plt.plot([-3, 3], [0, 0], "-C2", linewidth = 0.5)
+    plt.plot(abscissa, sinc_data - spline_data, "-C0")
+
+    # Show the plot
+    plt.show()
+
+# Interact with the degree
+interactive(cardinal_b_spline_as_sinc_plot, degree = (0, 9))
+
+
+

splinekit-0.0.4/.virtual_documents/development/Jupyter/bspline_interactive_shape.ipynb

@@ -0,0 +1,139 @@
+
+
+
+
+
+
+# Load the required libraries.
+from ipywidgets import interactive
+import matplotlib.pyplot as plt
+
+import splinekit as sk # This library
+
+# Define the plot function
+def b_spline_plot (
+    degree = 3
+):
+    # Support of a B-spline
+    supp = sk.b_spline_support(degree)
+    # Avoid overlap and leave a margin
+    # The margin serves a purpose only for the B-spline of degree 0
+    period = supp.diameter + 1
+    # Construct a spline from a non-overlapping periodic B-spline
+    s = sk.PeriodicSpline1D.periodized_b_spline(
+        period = int(period),
+        degree = degree
+    )
+    # Plot the B-spline
+    s.plot(
+        plt.subplots(),
+        plotdomain = sk.interval.Closed((-0.5 * supp.diameter, 0.5 * supp.diameter)),
+        plotrange = sk.interval.Closed((-0.05, 1.05)),
+        plotpoints = 200 + 1
+    )
+
+# Interact with the degree
+interactive(b_spline_plot, degree = (0, 30))
+
+
+
+
+
+# Load the required libraries.
+from ipywidgets import interactive
+import matplotlib.pyplot as plt
+
+import splinekit as sk # This library
+
+# Define the plot function
+def b_spline_plot (
+    degree = 3
+):
+    # Support of a B-spline
+    supp = sk.b_spline_support(degree)
+    # Avoid overlap and leave a margin
+    # The margin serves a purpose only for the B-spline of degree 0
+    period = supp.diameter + 1
+    # Construct a spline from a non-overlapping periodic B-spline
+    s = sk.PeriodicSpline1D.periodized_b_spline(
+        period = int(period),
+        degree = degree
+    )
+    # Get all finite derivatives
+    ds = [s.differentiated(m) for m in range(degree + 1)]
+    # Range of the plot
+    minrange = 0
+    maxrange = 0
+    if 0 == degree % 4:
+        minrange = ds[-1].at(1)
+        maxrange = ds[-1].at(0)
+    elif 1 == degree % 4:
+        minrange = ds[-1].at(0.5)
+        maxrange = ds[-1].at(-0.5)
+    elif 2 == degree % 4:
+        minrange = ds[-1].at(0)
+        maxrange = ds[-1].at(1)
+    elif 3 == degree % 4:
+        minrange = ds[-1].at(-0.5)
+        maxrange = ds[-1].at(0.5)
+    # Plot the B-spline and its derivatives
+    subplot = plt.subplots()
+    for m in range(degree + 1):
+        ds[m].plot(
+            subplot,
+            plotdomain = sk.interval.Closed((-0.5 * supp.diameter, 0.5 * supp.diameter)),
+            plotrange = sk.interval.Closed((minrange * 1.1, maxrange * 1.1)),
+            plotpoints = 200 + 1,
+            line_fmt = "-C" + str(m % 10),
+            marker_fmt = "",
+            stem_fmt = "None",
+            knot_marker = "",
+            periodbound_marker_fmt = "",
+            periodbound_stem_fmt = "None"
+        )
+
+# Interact with the degree
+interactive(b_spline_plot, degree = (0, 30))
+
+
+
+
+
+# Load the required libraries.
+from ipywidgets import interactive
+import matplotlib.pyplot as plt
+import numpy as np
+
+import splinekit as sk # This library
+
+# Define the plot function
+def int_b_spline_plot (
+    degree = 3
+):
+    # Support of a B-spline
+    supp = sk.b_spline_support(degree)
+    # Give space for the integral to rise and fall
+    period = 2 * int(supp.diameter)
+    # Construct a spline from a non-overlapping periodic B-spline
+    s = sk.PeriodicSpline1D.periodized_b_spline(period = period, degree = degree)
+    # Integration is equivalent to convolution with a box
+    b = np.concat((
+        np.ones(period // 2, dtype = float),
+        np.zeros(period // 2, dtype = float)
+    ))
+    box = sk.PeriodicSpline1D.from_spline_coeff(b, degree = 0, delay = 0.5)
+    s = sk.PeriodicSpline1D.convolve(s, box)
+    # Plot the integrated B-spline
+    s.plot(
+        plt.subplots(),
+        plotdomain = sk.interval.Closed((-0.5 * supp.diameter, 0.5 * supp.diameter)),
+        plotrange = sk.interval.Closed((-0.05, 1.05)),
+        plotpoints = 200 + 1,
+        knot_marker = ""
+    )
+
+# Interact with the degree
+interactive(int_b_spline_plot, degree = (0, 30))
+
+
+

splinekit-0.0.4/.virtual_documents/development/Jupyter/bspline_inverse_sequence.ipynb

@@ -0,0 +1,98 @@
+
+
+
+
+
+
+# Load the required libraries.
+from ipywidgets import interactive
+import matplotlib.pyplot as plt
+
+import splinekit as sk # This library
+
+# Setup
+min_arg = -6 # Leftmost integer argument of the domain
+max_arg = 6 # Rightmost integer argument of the domain
+k = range(min_arg, max_arg + 1)
+
+# Define the plot function
+def inv_b_spline_plot (
+    degree = 3
+):
+    # Data
+    ib = [sk.ib_coeff(q, degree) for q in k]
+    # Layout of the plot
+    (fig, ax) = plt.subplots()
+    ax.spines.right.set_visible(False)
+    ax.spines.top.set_visible(False)
+    plt.xticks(range(min_arg, max_arg + 1))
+    plt.ylim(-8, 10)
+    # Plot
+    (_, stemlines, baseline) = ax.stem(k, ib)
+    baseline.set_color("k")
+    baseline.set_linewidth(0.5)
+    stemlines.set_linewidth(0.25)
+    fig.tight_layout()
+
+# Interact with the degree
+interactive(inv_b_spline_plot, degree = (0, 9))
+
+
+
+
+
+# Load the required libraries.
+from ipywidgets import interactive
+import matplotlib.pyplot as plt
+
+import splinekit as sk # This library
+
+# Define the plot function
+def inv_b_spline_plot (
+    degree = 3,
+    period = 8
+):
+    # Non-periodized data
+    k = range(0, period // 2 + 1)
+    ib = [sk.ib_coeff(q, degree) for q in k]
+
+    # Periodized data
+    kp = range(0, period - 1 + 1)
+    ibp = sk.PeriodicSpline1D.periodized_cardinal_b_spline(
+        degree = degree,
+        period = period
+    ).spline_coeff
+
+    # Periodized plot
+    plt.subplot(211)
+    ax = plt.gca()
+    ax.spines.right.set_visible(False)
+    ax.spines.top.set_visible(False)
+    plt.xticks(kp)
+    plt.ylim(-9, 11)
+    (_, stemlines, baseline) = ax.stem(kp, ibp)
+    baseline.set_color("k")
+    baseline.set_linewidth(0.5)
+    stemlines.set_linewidth(0.25)
+    xlimp = plt.xlim()
+
+    # Difference plot
+    plt.subplot(212)
+    ax = plt.gca()
+    ax.spines.right.set_visible(False)
+    ax.spines.top.set_visible(False)
+    plt.xticks(kp)
+    plt.xlim(xlimp)
+    (_, stemlines, baseline) = ax.stem(k, ib - ibp[ : len(k)])
+    baseline.set_color("k")
+    baseline.set_linewidth(0.5)
+    stemlines.set_linewidth(0.25)
+    
+    # Show the plot
+    plt.show()
+
+# Interact with the degree
+interactive(inv_b_spline_plot, degree = (0, 9), period = (1, 15))
+
+
+