lsdo-function-spaces 1.0.0__tar.gz

lsdo_function_spaces-1.0.0/LICENSE.txt

@@ -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.

lsdo_function_spaces-1.0.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include LICENSE.txt README.md pyproject.toml release_notes.md
+recursive-include lsdo_function_spaces *.py
+recursive-include tests *.py
+recursive-exclude scratch *
+recursive-exclude docs *
+recursive-exclude examples *
+recursive-exclude stored_files *
+global-exclude __pycache__
+global-exclude *.py[co]
+global-exclude .DS_Store

lsdo_function_spaces-1.0.0/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: lsdo_function_spaces
+Version: 1.0.0
+Summary: A package for functional representation and function spaces in multidisciplinary design optimization.
+Author-email: Andrew Fletcher <afletcher168@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://lsdo-function-spaces.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/LSDOlab/lsdo_function_spaces
+Project-URL: Issue Tracker, https://github.com/LSDOlab/lsdo_function_spaces/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: pyvista
+Requires-Dist: joblib
+Requires-Dist: pandas
+Requires-Dist: scikit-learn
+Requires-Dist: jax
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Provides-Extra: docs
+Requires-Dist: myst-nb; extra == "docs"
+Requires-Dist: sphinx>=7.0; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: sphinx-autoapi>=3.0; extra == "docs"
+Requires-Dist: numpydoc; extra == "docs"
+Requires-Dist: gitpython; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
+Dynamic: license-file
+
+# lsdo_function_spaces
+
+[![Documentation Status](https://readthedocs.org/projects/lsdo-function-spaces/badge/?version=latest)](https://lsdo-function-spaces.readthedocs.io/en/latest/?badge=latest)
+[![Tests](https://github.com/LSDOlab/lsdo_function_spaces/actions/workflows/actions.yml/badge.svg)](https://github.com/LSDOlab/lsdo_function_spaces/actions)
+![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](LICENSE.txt)
+
+**lsdo_function_spaces** is a pure-Python library for constructing continuous, high-dimensional, differentiable function representations (B-splines, tensor-product splines, scattered data spaces, and multivariate polynomials) tailored for gradient-based Multidisciplinary Design Optimization (MDO) and scientific computing.
+
+Developed by the [Large-Scale Design Optimization (LSDO) Lab](https://lsdo.eng.ucsd.edu/) at the University of California, San Diego.
+
+---
+
+## Key Features
+
+* **Differentiable Function Spaces**: Unifies Cox-de Boor B-spline curves, surfaces, and volumes, Shepard inverse distance weighting (IDW), radial basis functions (RBF), and multivariate polynomials under an extensible functional abstraction.
+* **100% Pure Python & JAX Accelerated**: Zero Cython or C compiler dependencies. High-performance vectorized evaluation and projection algorithms implemented cleanly in NumPy with optional JAX JIT acceleration.
+* **Vectorized Inverse Point Projection**: Robust, vectorized Gauss-Newton and Levenberg-Marquardt algorithms with active-set bounds handling for projecting point clouds onto parametric spline curves, surfaces, and volumes.
+* **End-to-End CSDL Graph Integration**: Custom Vector-Jacobian Products (VJPs) and automatic differentiation through `csdl_alpha`, enabling exact analytic adjoint sensitivities across complex computational graphs.
+* **Interactive & Headless 3D Visualization**: Native PyVista support for visualizing spline control meshes, evaluated surface geometries, and discrete point clouds.
+
+---
+
+## Architecture Overview
+
+| Subpackage | Key Classes / Functions | Description |
+|:---|:---|:---|
+| **`lsdo_function_spaces.core.spaces`** | `BSplineSpace`, `FunctionSpace`, `ShepardSpace`, `PolynomialSpace`, `RBFSpace` | Core function space representations, basis function evaluations, and tensor-product constructions. |
+| **`lsdo_function_spaces.core.function`** | `Function`, `FunctionSet` | Concrete functional instances binding coefficient vectors to function spaces, supporting evaluation and composition. |
+| **`lsdo_function_spaces.core.spaces.non_cython_bsplines`** | `project_points_gauss_newton_numpy`, `project_points_lm_numpy`, `LMParams` | Vectorized inverse point projection engines utilizing active-set Levenberg-Marquardt and Gauss-Newton solvers. |
+| **`lsdo_function_spaces.core.b_spline_csdl_custom_ops`** | Custom CSDL evaluation operations | Differentiable computational graph operations providing exact forward and reverse-mode derivative evaluations. |
+
+---
+
+## Quickstart
+
+### Creating and Evaluating a B-spline Surface
+
+```python
+import numpy as np
+import csdl_alpha as csdl
+from lsdo_function_spaces import BSplineSpace, Function
+
+# 1. Define a 2D B-spline function space (degrees 3x3, 6x6 control points)
+space = BSplineSpace(
+    num_dimensions=2,
+    order=(4, 4),
+    num_coefficients=(6, 6),
+)
+
+# 2. Assign control point coefficients (e.g. parabolic saddle surface)
+u = np.linspace(0, 1, 6)
+v = np.linspace(0, 1, 6)
+U, V = np.meshgrid(u, v, indexing="ij")
+coefficients = np.stack([U, V, U**2 - V**2], axis=-1).reshape(-1, 3)
+
+func = Function(space=space, coefficients=coefficients)
+
+# 3. Evaluate surface at query parametric coordinates
+eval_pts = np.array([
+    [0.2, 0.3],
+    [0.5, 0.5],
+    [0.8, 0.9],
+])
+physical_coords = func.evaluate(eval_pts)
+print("Evaluated physical coordinates:\n", physical_coords)
+```
+
+### Inverse Parametric Point Projection
+
+```python
+import numpy as np
+from lsdo_function_spaces.core.spaces.non_cython_bsplines.b_spline_patch_projection_optimized import (
+    project_points_lm_numpy,
+    LMParams,
+)
+
+# Project arbitrary 3D points onto a B-spline surface patch
+points = np.array([[0.25, 0.35, 0.1]])
+u0s = np.array([[0.5, 0.5]])  # Initial parametric guess
+
+u_opt, converged, lam, res = project_points_lm_numpy(
+    points=points,
+    u0s=u0s,
+    coeffs=coefficients,
+    degrees=(3, 3),
+    knot_vectors=space.knot_vectors,
+    params=LMParams(max_iter=50, tol_grad=1e-8),
+)
+print("Converged parametric coordinate:", u_opt)
+```
+
+---
+
+## Installation
+
+### Prerequisites & Installation
+`lsdo_function_spaces` requires Python $\ge 3.9$ and standard scientific Python packages:
+
+```sh
+# 1. Install prerequisites
+pip install numpy scipy jax networkx
+pip install git+https://github.com/LSDOlab/CSDL_alpha.git@dev_andrew
+
+# 2. Install lsdo_function_spaces (User)
+pip install lsdo_function_spaces
+# Or install development version directly from GitHub:
+pip install git+https://github.com/LSDOlab/lsdo_function_spaces.git
+```
+
+### For Developers
+Clone the repository and install in editable mode with testing and documentation dependencies:
+```sh
+git clone https://github.com/LSDOlab/lsdo_function_spaces.git
+cd lsdo_function_spaces
+pip install -e ".[test,docs]"
+```
+
+---
+
+## Testing
+
+Run the full test suite with coverage:
+```sh
+pytest -v tests/ --cov=lsdo_function_spaces --cov-report=term-missing
+```
+
+For environments without a physical display (e.g. CI runners), run with `xvfb`:
+```sh
+xvfb-run --auto-servernum pytest -v tests/
+```
+
+---
+
+## Documentation
+
+Build the HTML documentation locally:
+```sh
+sphinx-build -b html docs docs/_build/html -q -W
+```
+View the generated documentation by opening `docs/_build/html/index.html` in any web browser.
+
+---
+
+## License
+
+This project is licensed under the terms of the **GNU Lesser General Public License v3.0** ([LGPL-3.0](LICENSE.txt)).

lsdo_function_spaces-1.0.0/README.md

@@ -0,0 +1,147 @@
+# lsdo_function_spaces
+
+[![Documentation Status](https://readthedocs.org/projects/lsdo-function-spaces/badge/?version=latest)](https://lsdo-function-spaces.readthedocs.io/en/latest/?badge=latest)
+[![Tests](https://github.com/LSDOlab/lsdo_function_spaces/actions/workflows/actions.yml/badge.svg)](https://github.com/LSDOlab/lsdo_function_spaces/actions)
+![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](LICENSE.txt)
+
+**lsdo_function_spaces** is a pure-Python library for constructing continuous, high-dimensional, differentiable function representations (B-splines, tensor-product splines, scattered data spaces, and multivariate polynomials) tailored for gradient-based Multidisciplinary Design Optimization (MDO) and scientific computing.
+
+Developed by the [Large-Scale Design Optimization (LSDO) Lab](https://lsdo.eng.ucsd.edu/) at the University of California, San Diego.
+
+---
+
+## Key Features
+
+* **Differentiable Function Spaces**: Unifies Cox-de Boor B-spline curves, surfaces, and volumes, Shepard inverse distance weighting (IDW), radial basis functions (RBF), and multivariate polynomials under an extensible functional abstraction.
+* **100% Pure Python & JAX Accelerated**: Zero Cython or C compiler dependencies. High-performance vectorized evaluation and projection algorithms implemented cleanly in NumPy with optional JAX JIT acceleration.
+* **Vectorized Inverse Point Projection**: Robust, vectorized Gauss-Newton and Levenberg-Marquardt algorithms with active-set bounds handling for projecting point clouds onto parametric spline curves, surfaces, and volumes.
+* **End-to-End CSDL Graph Integration**: Custom Vector-Jacobian Products (VJPs) and automatic differentiation through `csdl_alpha`, enabling exact analytic adjoint sensitivities across complex computational graphs.
+* **Interactive & Headless 3D Visualization**: Native PyVista support for visualizing spline control meshes, evaluated surface geometries, and discrete point clouds.
+
+---
+
+## Architecture Overview
+
+| Subpackage | Key Classes / Functions | Description |
+|:---|:---|:---|
+| **`lsdo_function_spaces.core.spaces`** | `BSplineSpace`, `FunctionSpace`, `ShepardSpace`, `PolynomialSpace`, `RBFSpace` | Core function space representations, basis function evaluations, and tensor-product constructions. |
+| **`lsdo_function_spaces.core.function`** | `Function`, `FunctionSet` | Concrete functional instances binding coefficient vectors to function spaces, supporting evaluation and composition. |
+| **`lsdo_function_spaces.core.spaces.non_cython_bsplines`** | `project_points_gauss_newton_numpy`, `project_points_lm_numpy`, `LMParams` | Vectorized inverse point projection engines utilizing active-set Levenberg-Marquardt and Gauss-Newton solvers. |
+| **`lsdo_function_spaces.core.b_spline_csdl_custom_ops`** | Custom CSDL evaluation operations | Differentiable computational graph operations providing exact forward and reverse-mode derivative evaluations. |
+
+---
+
+## Quickstart
+
+### Creating and Evaluating a B-spline Surface
+
+```python
+import numpy as np
+import csdl_alpha as csdl
+from lsdo_function_spaces import BSplineSpace, Function
+
+# 1. Define a 2D B-spline function space (degrees 3x3, 6x6 control points)
+space = BSplineSpace(
+    num_dimensions=2,
+    order=(4, 4),
+    num_coefficients=(6, 6),
+)
+
+# 2. Assign control point coefficients (e.g. parabolic saddle surface)
+u = np.linspace(0, 1, 6)
+v = np.linspace(0, 1, 6)
+U, V = np.meshgrid(u, v, indexing="ij")
+coefficients = np.stack([U, V, U**2 - V**2], axis=-1).reshape(-1, 3)
+
+func = Function(space=space, coefficients=coefficients)
+
+# 3. Evaluate surface at query parametric coordinates
+eval_pts = np.array([
+    [0.2, 0.3],
+    [0.5, 0.5],
+    [0.8, 0.9],
+])
+physical_coords = func.evaluate(eval_pts)
+print("Evaluated physical coordinates:\n", physical_coords)
+```
+
+### Inverse Parametric Point Projection
+
+```python
+import numpy as np
+from lsdo_function_spaces.core.spaces.non_cython_bsplines.b_spline_patch_projection_optimized import (
+    project_points_lm_numpy,
+    LMParams,
+)
+
+# Project arbitrary 3D points onto a B-spline surface patch
+points = np.array([[0.25, 0.35, 0.1]])
+u0s = np.array([[0.5, 0.5]])  # Initial parametric guess
+
+u_opt, converged, lam, res = project_points_lm_numpy(
+    points=points,
+    u0s=u0s,
+    coeffs=coefficients,
+    degrees=(3, 3),
+    knot_vectors=space.knot_vectors,
+    params=LMParams(max_iter=50, tol_grad=1e-8),
+)
+print("Converged parametric coordinate:", u_opt)
+```
+
+---
+
+## Installation
+
+### Prerequisites & Installation
+`lsdo_function_spaces` requires Python $\ge 3.9$ and standard scientific Python packages:
+
+```sh
+# 1. Install prerequisites
+pip install numpy scipy jax networkx
+pip install git+https://github.com/LSDOlab/CSDL_alpha.git@dev_andrew
+
+# 2. Install lsdo_function_spaces (User)
+pip install lsdo_function_spaces
+# Or install development version directly from GitHub:
+pip install git+https://github.com/LSDOlab/lsdo_function_spaces.git
+```
+
+### For Developers
+Clone the repository and install in editable mode with testing and documentation dependencies:
+```sh
+git clone https://github.com/LSDOlab/lsdo_function_spaces.git
+cd lsdo_function_spaces
+pip install -e ".[test,docs]"
+```
+
+---
+
+## Testing
+
+Run the full test suite with coverage:
+```sh
+pytest -v tests/ --cov=lsdo_function_spaces --cov-report=term-missing
+```
+
+For environments without a physical display (e.g. CI runners), run with `xvfb`:
+```sh
+xvfb-run --auto-servernum pytest -v tests/
+```
+
+---
+
+## Documentation
+
+Build the HTML documentation locally:
+```sh
+sphinx-build -b html docs docs/_build/html -q -W
+```
+View the generated documentation by opening `docs/_build/html/index.html` in any web browser.
+
+---
+
+## License
+
+This project is licensed under the terms of the **GNU Lesser General Public License v3.0** ([LGPL-3.0](LICENSE.txt)).

lsdo_function_spaces-1.0.0/lsdo_function_spaces/__init__.py

@@ -0,0 +1,64 @@
+"""lsdo_function_spaces: Functional representations and function spaces for MDO."""
+
+import multiprocessing
+
+__version__ = "1.0.0"
+num_workers = multiprocessing.cpu_count()
+
+# Core representations
+from .core.function import Function
+from .core.function_set import FunctionSet
+from .core.function_space import FunctionSpace, LinearFunctionSpace
+from .core.function_set_space import FunctionSetSpace
+
+# Function spaces
+from .core.spaces.b_spline_space import BSplineSpace, BSplineSpaceNew
+from .core.spaces.polynomial_space import PolynomialSpace
+from .core.spaces.conditional_space import ConditionalSpace
+from .core.spaces.idw_space import IDWFunctionSpace
+from .core.spaces.constant_space import ConstantSpace
+from .core.spaces.rbf_space import RBFFunctionSpace
+from .core.spaces.tri_space import LinearTriangulationSpace
+
+# Utilities
+from .utils.plotting_functions import (
+    plot_points,
+    plot_curve,
+    plot_surface,
+    show_plot,
+)
+from .utils.file_io import import_file, import_file_patched
+from .utils.utility_functions import (
+    create_b_spline_from_corners,
+    create_enclosure_block,
+)
+
+# Operations
+from .core.operations import operations
+
+__all__ = [
+    "__version__",
+    "num_workers",
+    "Function",
+    "FunctionSet",
+    "FunctionSpace",
+    "LinearFunctionSpace",
+    "FunctionSetSpace",
+    "BSplineSpace",
+    "BSplineSpaceNew",
+    "PolynomialSpace",
+    "ConditionalSpace",
+    "ConstantSpace",
+    "IDWFunctionSpace",
+    "RBFFunctionSpace",
+    "LinearTriangulationSpace",
+    "plot_points",
+    "plot_curve",
+    "plot_surface",
+    "show_plot",
+    "import_file",
+    "import_file_patched",
+    "create_b_spline_from_corners",
+    "create_enclosure_block",
+    "operations",
+]