scikit-fem-native 0.3.1__tar.gz

scikit_fem_native-0.3.1/.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - "**/*.md"
+      - "benchmarks/**/results/**"
+  pull_request:
+    paths-ignore:
+      - "**/*.md"
+      - "benchmarks/**/results/**"
+  workflow_dispatch:
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Python ${{ matrix.python }} on ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-24.04
+            python: "3.10"
+          - os: ubuntu-24.04
+            python: "3.14"
+          - os: macos-15
+            python: "3.14"
+          - os: windows-2025
+            python: "3.14"
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python }}
+          cache: pip
+      - name: Install package and test dependencies
+        run: python -m pip install --upgrade pip ".[test]"
+      - name: Run tests
+        run: python -m pytest
+
+  package:
+    name: Validate sdist and wheel
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+          cache: pip
+      - name: Build distributions
+        run: |
+          python -m pip install --upgrade build twine
+          python tools/package_check.py --smoke-only

scikit_fem_native-0.3.1/.github/workflows/full-validation.yml

@@ -0,0 +1,87 @@
+name: Full validation
+
+on:
+  workflow_dispatch:
+
+concurrency:
+  group: full-validation-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Python ${{ matrix.python }} on ${{ matrix.label }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-24.04
+            label: Linux x86_64
+            python: "3.10"
+          - os: ubuntu-24.04
+            label: Linux x86_64
+            python: "3.11"
+          - os: ubuntu-24.04
+            label: Linux x86_64
+            python: "3.12"
+          - os: ubuntu-24.04
+            label: Linux x86_64
+            python: "3.13"
+          - os: ubuntu-24.04
+            label: Linux x86_64
+            python: "3.14"
+          - os: macos-15
+            label: macOS arm64
+            python: "3.14"
+          - os: macos-15-intel
+            label: macOS x86_64
+            python: "3.14"
+          - os: windows-2025
+            label: Windows AMD64
+            python: "3.14"
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python }}
+          cache: pip
+      - name: Install package and test dependencies
+        run: python -m pip install --upgrade pip ".[test]"
+      - name: Run tests
+        run: python -m pytest
+
+  wheel-smoke:
+    name: Wheel smoke on ${{ matrix.label }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-24.04
+            label: Linux x86_64
+            platform: linux
+            arch: x86_64
+          - os: macos-15
+            label: macOS arm64
+            platform: macos
+            arch: arm64
+          - os: macos-15-intel
+            label: macOS x86_64
+            platform: macos
+            arch: x86_64
+          - os: windows-2025
+            label: Windows AMD64
+            platform: windows
+            arch: AMD64
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+      - name: Build and test one wheel
+        run: |
+          python -m pip install "cibuildwheel>=4,<5"
+          python tools/build_wheels.py --platform ${{ matrix.platform }} --arch ${{ matrix.arch }} --python 3.14

scikit_fem_native-0.3.1/.github/workflows/workflow.yml

@@ -0,0 +1,90 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+      - name: Check release version
+        run: >-
+          python tools/check_release_version.py
+          "${{ github.event.release.tag_name }}"
+      - name: Require a project license
+        run: python -c "from pathlib import Path; assert Path('LICENSE').is_file(), 'Add LICENSE before publishing'"
+      - name: Build source distribution
+        run: |
+          python -m pip install --upgrade build
+          python -m build --sdist
+      - uses: actions/upload-artifact@v7
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+          if-no-files-found: error
+          retention-days: 1
+
+  wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-24.04
+            platform: linux
+            arch: x86_64
+            artifact: linux-x86_64
+          - os: macos-15
+            platform: macos
+            arch: arm64
+            artifact: macos-arm64
+          - os: macos-15-intel
+            platform: macos
+            arch: x86_64
+            artifact: macos-x86_64
+          - os: windows-2025
+            platform: windows
+            arch: AMD64
+            artifact: windows-amd64
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+      - name: Build and test wheels
+        run: |
+          python -m pip install "cibuildwheel>=4,<5"
+          python tools/build_wheels.py --platform ${{ matrix.platform }} --arch ${{ matrix.arch }}
+      - uses: actions/upload-artifact@v7
+        with:
+          name: wheels-${{ matrix.artifact }}
+          path: wheelhouse/*.whl
+          if-no-files-found: error
+          retention-days: 1
+
+  publish:
+    name: Publish to PyPI
+    needs: [sdist, wheels]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/scikit-fem-native/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          path: dist
+          merge-multiple: true
+      - name: Publish package distributions
+        uses: pypa/gh-action-pypi-publish@release/v1

scikit_fem_native-0.3.1/.gitignore

@@ -0,0 +1,10 @@
+__pycache__/
+*.py[cod]
+*.so
+.pytest_cache/
+.coverage
+build/
+dist/
+wheelhouse/
+*.egg-info/
+.venv/

scikit_fem_native-0.3.1/.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

scikit_fem_native-0.3.1/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+## 0.3.1 — 2026-08-21
+
+- Align package distribution rename to `scikit-fem-native` with canonical
+  documentation and repository metadata references.
+- Fix remaining project metadata and docs links to avoid inconsistent
+  `skfem-native` / `scikit-fem-native` navigation during user onboarding.
+
+## 0.3.0 — 2026-08-13
+
+### Added
+
+- Experimental lowest-order Nedelec H(curl) vertical slices for affine
+  triangles and tetrahedra, including oriented edge DOFs, covariant Piola
+  mapping, interpolation, quadrature evaluation, boundary constraints, vector
+  loads, and reusable mass/curl-curl/Maxwell assembly.
+- A threaded native TetN1 integration kernel and native edge-topology/CSR setup
+  kernels, with explicit application-owned thread control.
+- Conservative memory preflight for the dedicated H(curl) assemblers and
+  recorded TetN1 performance and memory calibration benchmarks.
+- Typed-form support for multiple coefficients, coefficient components, and
+  scalar anisotropic gradient contractions.
+- Machine-readable capability declarations and explicit errors for unsupported
+  mathematical operations.
+- Documentation and compatibility examples for scikit-fem-style workflows.
+
+### Changed
+
+- Vectorized TriN1 basis mapping and moved size-dependent edge numbering and
+  CSR setup loops to native code.
+- Stabilized public tensor layouts: component-first public coefficient/basis
+  views and entity-first private native storage are documented explicitly.
+- Expanded geometry, orientation, convergence, distorted-mesh, memory-budget,
+  and cross-platform validation.
+
+### Fixed
+
+- Made memory calibration portable to Windows by using the Win32 process
+  working-set API when the Unix-only `resource` module is unavailable.
+
+### Scope
+
+H(curl) support remains experimental and is limited to dedicated affine TriN1
+and TetN1 APIs.  General `Basis`/`asm` integration, curved H(curl) mappings,
+higher-order Nedelec elements, and solver policy are not included.
+
+## 0.2.1
+
+- Previous PyPI release.  This changelog begins with the consolidated 0.3.0
+  release notes; older history remains available in the Git repository.

scikit_fem_native-0.3.1/CMakeLists.txt

@@ -0,0 +1,29 @@
+cmake_minimum_required(VERSION 3.18)
+project(skfem_native LANGUAGES CXX)
+
+find_package(Python REQUIRED COMPONENTS Interpreter Development.Module)
+find_package(pybind11 CONFIG REQUIRED)
+
+pybind11_add_module(
+  _skfn
+  cpp/src/bindings.cpp
+  cpp/src/runtime.cpp
+  cpp/src/assembly/linear_form_assembler.cpp
+  cpp/src/assembly/functional_assembler.cpp
+  cpp/src/assembly/supermesh_builder.cpp
+  cpp/src/assembly/bilinear_form_assembler.cpp
+  cpp/src/assembly/cross_bilinear_assembler.cpp
+  cpp/src/assembly/cut_form_assembler.cpp
+  cpp/src/assembly/cut_cross_assembler.cpp
+  cpp/src/assembly/basis_geometry.cpp
+  cpp/src/assembly/edge_topology.cpp
+)
+target_compile_features(_skfn PRIVATE cxx_std_17)
+target_include_directories(_skfn PRIVATE cpp/include)
+if(MSVC)
+  target_compile_options(_skfn PRIVATE /O2 /W4)
+else()
+  target_compile_options(_skfn PRIVATE -O3 -Wall -Wextra -Wpedantic)
+endif()
+
+install(TARGETS _skfn DESTINATION skfemntv)

scikit_fem_native-0.3.1/DEVELOPMENT.md

@@ -0,0 +1,80 @@
+# Development philosophy
+
+## Purpose
+
+scikit-fem makes finite-element formulations easy to express, inspect, and
+test in Python.  `skfem-native` improves the numerical assembly part of that
+workflow without moving application mathematics into a compiled framework.
+
+This distinction matters increasingly in AI-assisted development.  Nonlinear
+constitutive laws, coupled weak forms, and application-specific contact
+algorithms can be written and revised rapidly when they remain ordinary Python
+components.  The compiled layer should accelerate stable, reusable numerical
+operations rather than become the owner of every material or formulation.
+
+The project therefore aims to preserve two properties:
+
+- application code remains readable Python close to the mathematics
+- performance-critical, reusable assembly machinery runs in native code
+
+## Ownership boundary
+
+`skfemntv` owns:
+
+- meshes, elements, bases, tabulation, and quadrature
+- generic functional, linear, bilinear, and cross-bilinear assembly
+- assembly from caller-supplied tensor coefficients
+- sparse scatter and threaded native kernels
+- cut-cell and implicit-interface quadrature
+- interface supermeshes and contact-facet search
+- geometry and integration diagnostics
+
+The calling application owns:
+
+- weak forms and coefficient fields
+- constitutive updates and state histories
+- contact and interface formulations
+- multiplier spaces, stabilization, and algebraic reduction
+- nonlinear stepping, linear solvers, and convergence policy
+
+For example, an application can define one nonlinear material update and pass
+the resulting coefficient and tangent tensors through either `skfem.asm` or
+`skfemntv.asm`.  Likewise, `skfemntv` may construct shared interface geometry,
+but the application decides whether that geometry is used for Mortar, dual,
+Nitsche, or another contact formulation.
+
+## Design principles
+
+1. Keep the public assembly call shape close to scikit-fem.
+2. Keep formulation-specific policy out of the backend.
+3. Prefer generic coefficient and tensor assembly over material-specific APIs.
+4. Make backend selection explicit and test numerical equivalence.
+5. Keep diagnostics available at Python boundaries.
+6. Remove misleading abstractions rather than preserving accidental APIs.
+
+## Public degree-of-freedom ordering
+
+Supported backends must expose the same global degree-of-freedom ordering as
+scikit-fem.  The canonical order groups DOFs by topological entity: vertices,
+then shared edges or facets, then element interiors.  Local native kernels may
+use explicit high-order connectivity, but that representation must not leak as
+a different public vector or matrix ordering.
+
+Entity-based numbering is preferred over assigning new nodes while traversing
+elements because it is independent of first encounter, keeps boundary and
+interior blocks identifiable, supports direct backend interchange, and follows
+the decomposition used by scikit-fem's `Dofs` implementation.
+
+Gallery compatibility tests must compare public matrices and vectors directly.
+A coordinate permutation is useful for diagnosing an ordering defect, but is
+not an acceptable permanent compatibility layer for a supported element.
+
+## Compatibility
+
+`skfemntv` is a selectable backend, not a promise of complete scikit-fem API
+coverage.  Shared call shapes should produce equivalent numerical results, but
+applications should not rely on implicit backend substitution.
+
+Version 0.2 intentionally removed formulation-specific 0.1 APIs such as native
+material models, Mortar reduction policy, KKT types, and specialized Nitsche
+assembly.  Those responsibilities belong to the application layer.

scikit_fem_native-0.3.1/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

scikit_fem_native-0.3.1/NOTICE

@@ -0,0 +1,6 @@
+skfem-native
+
+Copyright (C) 2026 Kohei Watanabe
+
+Licensed under LGPL-3.0-or-later.
+See the LICENSE file for details.