lsdo-geo 1.0.0__tar.gz

lsdo_geo-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_geo-1.0.0/MANIFEST.in

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

lsdo_geo-1.0.0/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: lsdo_geo
+Version: 1.0.0
+Summary: A package for geometry and state modeling/representation, parameterization, and mesh creation for MDO.
+Author-email: Andrew Fletcher <afletcher168@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://lsdo-geo.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/LSDOlab/lsdo_geo
+Project-URL: Issue Tracker, https://github.com/LSDOlab/lsdo_geo/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: pyvista
+Requires-Dist: joblib
+Requires-Dist: pandas
+Requires-Dist: scipy
+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_geo
+
+[![Documentation Status](https://readthedocs.org/projects/lsdo-geo/badge/?version=latest)](https://lsdo-geo.readthedocs.io/en/latest/?badge=latest)
+[![Tests](https://github.com/LSDOlab/lsdo_geo/actions/workflows/actions.yml/badge.svg)](https://github.com/LSDOlab/lsdo_geo/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](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE.txt)
+
+**lsdo_geo** is a Python library for geometry representation, implicit deformational parameterization, and analytic adjoint sensitivity analysis tailored for gradient-based Multidisciplinary Design Optimization (MDO).
+
+Developed by the [Large-Scale Design Optimization (LSDO) Lab](https://lsdo.eng.ucsd.edu/) at the University of California, San Diego.
+
+---
+
+## Key Features
+
+* **Geometry-Centric MDO**: Serves as a single, consistent geometric "source of truth", generating and updating discipline-specific meshes (CFD, FEA, acoustics) without manual re-meshing or geometric inconsistency.
+* **Implicit Parameterization Framework**: Formulates geometry parameterization as an inner constrained optimization problem, solving the first-order Karush-Kuhn-Tucker (KKT) system with an exact Newton solver.
+* **Hierarchical Free-Form Deformation (FFD)**: Supports trivariate spline volume lattices with sectional deformation modes—twist, sweep, dihedral, spanwise stretching, and chord taper.
+* **Analytic Adjoint Sensitivities**: Provides exact implicit derivatives $\frac{d\mathbf{x}}{d\mathbf{x}_g}$ through the converged KKT state, seamlessly propagating gradients across the CSDL computational graph.
+* **CAD & Mesh Interoperability**: Direct import, fitting, and export across OpenVSP (`.vsp3`), IGES (`.iges`), STEP (`.stp`), and surface/volume meshes (`.msh`, `.stl`).
+
+---
+
+## Architecture Overview
+
+| Subpackage | Key Classes | Description |
+|:---|:---|:---|
+| **`lsdo_geo.core.geometry`** | `Geometry`, `Mesh` | Central multi-component geometric model, CAD imports, rigid transformations, and discipline mesh projections. |
+| **`lsdo_geo.core.parameterization`** | `ParameterizationSolver`, `GeometricVariables`, `FFDBlock`, `SectionalParameterization` | Trivariate FFD lattices, sectional mode definitions, and exact Newton KKT solver. |
+| **`lsdo_geo.optimization`** | `Optimization`, `NewtonOptimizer` | Connects geometric states and constraints into CSDL graph models for analytic adjoint sensitivity analysis. |
+
+---
+
+## Quickstart
+
+```python
+import numpy as np
+import csdl_alpha as csdl
+import lsdo_geo as lg
+
+# 1. Initialize CSDL graph recorder
+recorder = csdl.Recorder(inline=True)
+recorder.start()
+
+# 2. Define or import geometry
+geometry = lg.import_geometry("path/to/wing.stp")
+
+# 3. Create a Free-Form Deformation (FFD) block around the geometry
+ffd_block = lg.construct_ffd_block_around_entities(
+    geometry,
+    num_control_points=(4, 4, 2),
+)
+
+# 4. Apply geometric transformations (rotation, translation)
+rotation_origin = np.array([0.0, 0.0, 0.0])
+rotation_axis = np.array([0.0, 0.0, 1.0])
+rotated_points = lg.rotate(
+    geometry.coefficients,
+    rotation_origin=rotation_origin,
+    axis_vector=rotation_axis,
+    angles=15.0,
+    units="degrees",
+)
+```
+
+---
+
+## Installation
+
+### Prerequisites & Installation
+`lsdo_geo` relies on `CSDL_alpha` and `lsdo_function_spaces`:
+
+```sh
+# 1. Install dependencies
+pip install jax networkx
+pip install git+https://github.com/LSDOlab/CSDL_alpha.git@dev_andrew
+pip install git+https://github.com/LSDOlab/lsdo_function_spaces.git
+
+# 2. Install lsdo_geo (User)
+pip install lsdo_geo
+# Or install development version directly from GitHub:
+pip install git+https://github.com/LSDOlab/lsdo_geo.git
+```
+
+### For Developers
+Clone the repository and install in editable mode with testing and documentation extras:
+```sh
+git clone https://github.com/LSDOlab/lsdo_geo.git
+cd lsdo_geo
+pip install jax networkx
+pip install git+https://github.com/LSDOlab/CSDL_alpha.git@dev_andrew
+pip install git+https://github.com/LSDOlab/lsdo_function_spaces.git
+pip install -e ".[test,docs]"
+```
+
+---
+
+## Testing
+
+Run the test suite using `pytest`:
+```sh
+pytest
+```
+
+To run fast unit tests only:
+```sh
+pytest -m "not slow"
+```
+
+---
+
+## Documentation
+
+Full documentation, theoretical background, tutorials, and API reference are hosted on Read the Docs:
+👉 **[lsdo-geo.readthedocs.io](https://lsdo-geo.readthedocs.io/en/latest/)**
+
+To build the documentation locally:
+```sh
+sphinx-build -b html docs docs/_build/html
+```
+
+---
+
+## License
+
+`lsdo_geo` is distributed under the terms of the Apache License 2.0. See [LICENSE.txt](LICENSE.txt) for details.

lsdo_geo-1.0.0/README.md

@@ -0,0 +1,126 @@
+# lsdo_geo
+
+[![Documentation Status](https://readthedocs.org/projects/lsdo-geo/badge/?version=latest)](https://lsdo-geo.readthedocs.io/en/latest/?badge=latest)
+[![Tests](https://github.com/LSDOlab/lsdo_geo/actions/workflows/actions.yml/badge.svg)](https://github.com/LSDOlab/lsdo_geo/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](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE.txt)
+
+**lsdo_geo** is a Python library for geometry representation, implicit deformational parameterization, and analytic adjoint sensitivity analysis tailored for gradient-based Multidisciplinary Design Optimization (MDO).
+
+Developed by the [Large-Scale Design Optimization (LSDO) Lab](https://lsdo.eng.ucsd.edu/) at the University of California, San Diego.
+
+---
+
+## Key Features
+
+* **Geometry-Centric MDO**: Serves as a single, consistent geometric "source of truth", generating and updating discipline-specific meshes (CFD, FEA, acoustics) without manual re-meshing or geometric inconsistency.
+* **Implicit Parameterization Framework**: Formulates geometry parameterization as an inner constrained optimization problem, solving the first-order Karush-Kuhn-Tucker (KKT) system with an exact Newton solver.
+* **Hierarchical Free-Form Deformation (FFD)**: Supports trivariate spline volume lattices with sectional deformation modes—twist, sweep, dihedral, spanwise stretching, and chord taper.
+* **Analytic Adjoint Sensitivities**: Provides exact implicit derivatives $\frac{d\mathbf{x}}{d\mathbf{x}_g}$ through the converged KKT state, seamlessly propagating gradients across the CSDL computational graph.
+* **CAD & Mesh Interoperability**: Direct import, fitting, and export across OpenVSP (`.vsp3`), IGES (`.iges`), STEP (`.stp`), and surface/volume meshes (`.msh`, `.stl`).
+
+---
+
+## Architecture Overview
+
+| Subpackage | Key Classes | Description |
+|:---|:---|:---|
+| **`lsdo_geo.core.geometry`** | `Geometry`, `Mesh` | Central multi-component geometric model, CAD imports, rigid transformations, and discipline mesh projections. |
+| **`lsdo_geo.core.parameterization`** | `ParameterizationSolver`, `GeometricVariables`, `FFDBlock`, `SectionalParameterization` | Trivariate FFD lattices, sectional mode definitions, and exact Newton KKT solver. |
+| **`lsdo_geo.optimization`** | `Optimization`, `NewtonOptimizer` | Connects geometric states and constraints into CSDL graph models for analytic adjoint sensitivity analysis. |
+
+---
+
+## Quickstart
+
+```python
+import numpy as np
+import csdl_alpha as csdl
+import lsdo_geo as lg
+
+# 1. Initialize CSDL graph recorder
+recorder = csdl.Recorder(inline=True)
+recorder.start()
+
+# 2. Define or import geometry
+geometry = lg.import_geometry("path/to/wing.stp")
+
+# 3. Create a Free-Form Deformation (FFD) block around the geometry
+ffd_block = lg.construct_ffd_block_around_entities(
+    geometry,
+    num_control_points=(4, 4, 2),
+)
+
+# 4. Apply geometric transformations (rotation, translation)
+rotation_origin = np.array([0.0, 0.0, 0.0])
+rotation_axis = np.array([0.0, 0.0, 1.0])
+rotated_points = lg.rotate(
+    geometry.coefficients,
+    rotation_origin=rotation_origin,
+    axis_vector=rotation_axis,
+    angles=15.0,
+    units="degrees",
+)
+```
+
+---
+
+## Installation
+
+### Prerequisites & Installation
+`lsdo_geo` relies on `CSDL_alpha` and `lsdo_function_spaces`:
+
+```sh
+# 1. Install dependencies
+pip install jax networkx
+pip install git+https://github.com/LSDOlab/CSDL_alpha.git@dev_andrew
+pip install git+https://github.com/LSDOlab/lsdo_function_spaces.git
+
+# 2. Install lsdo_geo (User)
+pip install lsdo_geo
+# Or install development version directly from GitHub:
+pip install git+https://github.com/LSDOlab/lsdo_geo.git
+```
+
+### For Developers
+Clone the repository and install in editable mode with testing and documentation extras:
+```sh
+git clone https://github.com/LSDOlab/lsdo_geo.git
+cd lsdo_geo
+pip install jax networkx
+pip install git+https://github.com/LSDOlab/CSDL_alpha.git@dev_andrew
+pip install git+https://github.com/LSDOlab/lsdo_function_spaces.git
+pip install -e ".[test,docs]"
+```
+
+---
+
+## Testing
+
+Run the test suite using `pytest`:
+```sh
+pytest
+```
+
+To run fast unit tests only:
+```sh
+pytest -m "not slow"
+```
+
+---
+
+## Documentation
+
+Full documentation, theoretical background, tutorials, and API reference are hosted on Read the Docs:
+👉 **[lsdo-geo.readthedocs.io](https://lsdo-geo.readthedocs.io/en/latest/)**
+
+To build the documentation locally:
+```sh
+sphinx-build -b html docs docs/_build/html
+```
+
+---
+
+## License
+
+`lsdo_geo` is distributed under the terms of the Apache License 2.0. See [LICENSE.txt](LICENSE.txt) for details.

lsdo_geo-1.0.0/lsdo_geo/__init__.py

@@ -0,0 +1,60 @@
+"""
+lsdo_geo: Geometry representation, deformational parameterization,
+and sensitivity analysis for Multidisciplinary Design Optimization (MDO).
+"""
+
+__version__ = "1.0.0"
+
+from .core.geometry.geometry import Geometry
+from .core.geometry.mesh import Mesh
+from .core.geometry.geometry_functions import (
+    import_geometry,
+    rotate,
+    apply_quaternion_rotation,
+    hamilton_product,
+)
+from .core.parameterization.ffd_block import FFDBlock
+from .core.parameterization.free_form_deformation_functions import (
+    construct_ffd_block_around_entities,
+    construct_ffd_block_from_corners,
+    construct_tight_fit_ffd_block,
+)
+from .core.parameterization.sectional_parameterization import (
+    SectionalParameterization,
+    SectionalParameters,
+    VolumeSectionalParameterization,
+    VolumeSectionalParameterizationInputs,
+)
+from .core.parameterization.parameterization_solver import (
+    ParameterizationSolver,
+    GeometricVariables,
+)
+from .optimization import (
+    Optimization,
+    NewtonOptimizer,
+)
+
+__all__ = [
+    "__version__",
+    # Geometry
+    "Geometry",
+    "Mesh",
+    "import_geometry",
+    "rotate",
+    "apply_quaternion_rotation",
+    "hamilton_product",
+    # Parameterization
+    "FFDBlock",
+    "construct_ffd_block_around_entities",
+    "construct_ffd_block_from_corners",
+    "construct_tight_fit_ffd_block",
+    "SectionalParameterization",
+    "SectionalParameters",
+    "VolumeSectionalParameterization",
+    "VolumeSectionalParameterizationInputs",
+    "ParameterizationSolver",
+    "GeometricVariables",
+    # Optimization
+    "Optimization",
+    "NewtonOptimizer",
+]