DeepSDFStruct 1.7.2__py3-none-any.whl

deepsdfstruct-1.7.2.dist-info/scm_file_list.json

@@ -0,0 +1,178 @@
+{
+  "files": [
+    "LICENSE",
+    "uv.lock",
+    ".pre-commit-config.yaml",
+    "pyproject.toml",
+    "MANIFEST.in",
+    "NOTICE",
+    ".deepsource.toml",
+    "README.md",
+    "example.ipynb",
+    ".gitignore",
+    "AGENT_INSTRUCTIONS.md",
+    "SDF_FEATURE_TRACKING.md",
+    "tests/test_mesh_functions.py",
+    "tests/test_torch_spline.py",
+    "tests/test_DOE.py",
+    "tests/test_mesh_export.py",
+    "tests/test_sdf_trimesh_comparison.py",
+    "tests/test_flexisquares.py",
+    "tests/test_train_model.py",
+    "tests/test_pretrained_models.py",
+    "tests/test_sdf_primitives.py",
+    "tests/test_structural_optimization.py",
+    "tests/test_sdf_functions.py",
+    "tests/test_sdf_from_mesh.py",
+    "tests/test_networks.py",
+    "tests/test_training_data_ids.py",
+    "tests/test_elongate_sdf.py",
+    "tests/test_lattice_evaluation.py",
+    "tests/test_generate_dataset.py",
+    "tests/test_reconstruction.py",
+    "tests/test_splinepy_unitcells.py",
+    "tests/tmp_outputs/temp_file.txt",
+    "tests/data/stanford_bunny.stl",
+    "tests/data/example_disconnectd_mesh.inp",
+    "tests/data/sweep_test_case.stl",
+    "tests/data/cone.stl",
+    "tests/data/circular_balls_test_case.stl",
+    "tests/data/example_line_mesh.vtk",
+    "tests/data/chairs/1024.obj",
+    "tests/data/chairs/README.md",
+    "tests/data/chairs/1005.obj",
+    "docs/index.rst",
+    "docs/api_reference.rst",
+    "docs/qr_code_paper.png",
+    "docs/Makefile",
+    "docs/qr_code_github.png",
+    "docs/conf.py",
+    "docs/make.bat",
+    "docs/readme_images/example_output_01.png",
+    "docs/readme_images/example_output_02.png",
+    "docs/readme_images/example_output_03.png",
+    "docs/readme_images/example_output_04.png",
+    "benchmarks/generate_sdf_showcase.py",
+    "benchmarks/sdf_from_mesh_benchmark.py",
+    "benchmarks/sdf_from_mesh_comparison.md",
+    "benchmarks/sdf_showcase/operations/transformations/shell_sphere.png",
+    "benchmarks/sdf_showcase/operations/transformations/mirror_sphere.png",
+    "benchmarks/sdf_showcase/operations/transformations/circular_array_sphere.png",
+    "benchmarks/sdf_showcase/operations/transformations/twist_torus.png",
+    "benchmarks/sdf_showcase/operations/transformations/dilate_sphere.png",
+    "benchmarks/sdf_showcase/operations/transformations/repeat_sphere.png",
+    "benchmarks/sdf_showcase/operations/transformations/revolve_circle.png",
+    "benchmarks/sdf_showcase/operations/boolean/union_sphere_box.png",
+    "benchmarks/sdf_showcase/operations/boolean/difference_sphere_box.png",
+    "benchmarks/sdf_showcase/primitives/3D/icosahedron.png",
+    "benchmarks/sdf_showcase/primitives/3D/ellipsoid.png",
+    "benchmarks/sdf_showcase/primitives/3D/rounded_box.png",
+    "benchmarks/sdf_showcase/primitives/3D/sphere.png",
+    "benchmarks/sdf_showcase/primitives/3D/corner_spheres.png",
+    "benchmarks/sdf_showcase/primitives/3D/torus.png",
+    "benchmarks/sdf_showcase/primitives/3D/dodecahedron.png",
+    "benchmarks/sdf_showcase/primitives/3D/rounded_cone.png",
+    "benchmarks/sdf_showcase/primitives/3D/cone.png",
+    "benchmarks/sdf_showcase/primitives/3D/capsule.png",
+    "benchmarks/sdf_showcase/primitives/3D/capped_cylinder.png",
+    "benchmarks/sdf_showcase/primitives/3D/cross_ms.png",
+    "benchmarks/sdf_showcase/primitives/3D/wireframe_box.png",
+    "benchmarks/sdf_showcase/primitives/3D/tetrahedron.png",
+    "benchmarks/sdf_showcase/primitives/3D/cylinder.png",
+    "benchmarks/sdf_showcase/primitives/3D/octahedron.png",
+    "benchmarks/sdf_showcase/primitives/3D/pyramid.png",
+    "benchmarks/sdf_showcase/primitives/3D/rounded_cylinder.png",
+    "benchmarks/sdf_showcase/primitives/3D/box.png",
+    "benchmarks/sdf_showcase/primitives/3D/capped_cone.png",
+    "benchmarks/sdf_showcase/primitives/2D/rounded_rectangle.png",
+    "benchmarks/sdf_showcase/primitives/2D/hexagon.png",
+    "benchmarks/sdf_showcase/primitives/2D/rectangle.png",
+    "benchmarks/sdf_showcase/primitives/2D/circle.png",
+    "benchmarks/sdf_showcase/primitives/2D/polygon_pentagon.png",
+    "benchmarks/sdf_showcase/primitives/2D/equilateral_triangle.png",
+    "DeepSDFStruct/pretrained_models.py",
+    "DeepSDFStruct/sdf_primitives.py",
+    "DeepSDFStruct/optimization.py",
+    "DeepSDFStruct/lattice_structure.py",
+    "DeepSDFStruct/__init__.py",
+    "DeepSDFStruct/mesh.py",
+    "DeepSDFStruct/sdf_operations.py",
+    "DeepSDFStruct/utils.py",
+    "DeepSDFStruct/SDF.py",
+    "DeepSDFStruct/design_of_experiments.py",
+    "DeepSDFStruct/sampling.py",
+    "DeepSDFStruct/local_shapes.py",
+    "DeepSDFStruct/parametrization.py",
+    "DeepSDFStruct/torch_spline.py",
+    "DeepSDFStruct/visualization/latent_viewer_cli.py",
+    "DeepSDFStruct/visualization/latent_viewer.py",
+    "DeepSDFStruct/flexicubes/__init__.py",
+    "DeepSDFStruct/flexicubes/tables.py",
+    "DeepSDFStruct/flexicubes/flexicubes.py",
+    "DeepSDFStruct/trained_models/primitives_2d/specs.json",
+    "DeepSDFStruct/trained_models/primitives_2d/OptimizerParameters/latest.pth",
+    "DeepSDFStruct/trained_models/primitives_2d/LatentCodes/latest.pth",
+    "DeepSDFStruct/trained_models/primitives_2d/ModelParameters/latest.pth",
+    "DeepSDFStruct/trained_models/test_experiment_hierarchical/specs.json",
+    "DeepSDFStruct/trained_models/test_experiment_hierarchical/training_summary.json",
+    "DeepSDFStruct/trained_models/test_experiment_hierarchical/LatentCodes/latent_code_data_map.json",
+    "DeepSDFStruct/trained_models/test_experiment_homogenization/Logs.png",
+    "DeepSDFStruct/trained_models/test_experiment_homogenization/specs.json",
+    "DeepSDFStruct/trained_models/test_experiment_homogenization/training_summary.json",
+    "DeepSDFStruct/trained_models/test_experiment_homogenization/OptimizerParameters/latest.pth",
+    "DeepSDFStruct/trained_models/test_experiment_homogenization/LatentCodes/latent_code_data_map.json",
+    "DeepSDFStruct/trained_models/test_experiment_homogenization/LatentCodes/latest.pth",
+    "DeepSDFStruct/trained_models/test_experiment_homogenization/ModelParameters/latest.pth",
+    "DeepSDFStruct/trained_models/primitives/specs.json",
+    "DeepSDFStruct/trained_models/primitives/OptimizerParameters/latest.pth",
+    "DeepSDFStruct/trained_models/primitives/LatentCodes/latest.pth",
+    "DeepSDFStruct/trained_models/primitives/ModelParameters/latest.pth",
+    "DeepSDFStruct/trained_models/test_experiment/specs.json",
+    "DeepSDFStruct/trained_models/test_experiment/training_summary.json",
+    "DeepSDFStruct/trained_models/test_experiment/LatentCodes/latent_code_data_map.json",
+    "DeepSDFStruct/trained_models/chi_and_cross/specs.json",
+    "DeepSDFStruct/trained_models/chi_and_cross/Logs.pth",
+    "DeepSDFStruct/trained_models/chi_and_cross/OptimizerParameters/latest.pth",
+    "DeepSDFStruct/trained_models/chi_and_cross/LatentCodes/latest.pth",
+    "DeepSDFStruct/trained_models/chi_and_cross/ModelParameters/latest.pth",
+    "DeepSDFStruct/trained_models/analytic_round_cross/specs.json",
+    "DeepSDFStruct/trained_models/analytic_round_cross/OptimizerParameters/latest.pth",
+    "DeepSDFStruct/trained_models/analytic_round_cross/LatentCodes/latest.pth",
+    "DeepSDFStruct/trained_models/analytic_round_cross/ModelParameters/latest.pth",
+    "DeepSDFStruct/trained_models/round_cross/specs.json",
+    "DeepSDFStruct/trained_models/round_cross/Logs.pth",
+    "DeepSDFStruct/trained_models/round_cross/OptimizerParameters/latest.pth",
+    "DeepSDFStruct/trained_models/round_cross/LatentCodes/latest.pth",
+    "DeepSDFStruct/trained_models/round_cross/ModelParameters/latest.pth",
+    "DeepSDFStruct/deep_sdf/reconstruction.py",
+    "DeepSDFStruct/deep_sdf/models.py",
+    "DeepSDFStruct/deep_sdf/plotting.py",
+    "DeepSDFStruct/deep_sdf/__init__.py",
+    "DeepSDFStruct/deep_sdf/workspace.py",
+    "DeepSDFStruct/deep_sdf/create_screenshots_from_plyfiles.py",
+    "DeepSDFStruct/deep_sdf/nn_utils.py",
+    "DeepSDFStruct/deep_sdf/training.py",
+    "DeepSDFStruct/deep_sdf/data.py",
+    "DeepSDFStruct/deep_sdf/metrics/mesh_to_analytical.py",
+    "DeepSDFStruct/deep_sdf/metrics/__init__.py",
+    "DeepSDFStruct/deep_sdf/networks/__init__.py",
+    "DeepSDFStruct/deep_sdf/networks/analytic_round_cross.py",
+    "DeepSDFStruct/deep_sdf/networks/resnet_positional_sdf_decoder.py",
+    "DeepSDFStruct/deep_sdf/networks/hierarchical_positional_sdf_decoder.py",
+    "DeepSDFStruct/deep_sdf/networks/hierarchical_deep_sdf_decoder.py",
+    "DeepSDFStruct/deep_sdf/networks/deep_sdf_decoder.py",
+    "DeepSDFStruct/flexisquares/__init__.py",
+    "DeepSDFStruct/flexisquares/flexisquares.py",
+    "DeepSDFStruct/flexisquares/tables.py",
+    "DeepSDFStruct/splinepy_unitcells/cross_lattice.py",
+    "DeepSDFStruct/splinepy_unitcells/__init__.py",
+    "DeepSDFStruct/splinepy_unitcells/snappy_3d.py",
+    "DeepSDFStruct/splinepy_unitcells/chi_3D.py",
+    "DeepSDFStruct/splinepy_unitcells/double_lattice_extruded.py",
+    ".github/copilot-instructions.md",
+    ".github/workflows/publish.yml",
+    ".github/workflows/test.yml",
+    ".github/workflows/docs.yml",
+    ".github/workflows/copilot-setup-steps.yml"
+  ]
+}

deepsdfstruct-1.7.2.dist-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "1.7.2",
+  "distance": 0,
+  "node": "g27ad05453a6ccc347866c55444c7d82d2b8b6f6d",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-07-10"
+}

deepsdfstruct-1.7.2.dist-info/top_level.txt

@@ -0,0 +1,4 @@
+DeepSDFStruct
+benchmarks
+docs
+tests

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api_reference.rst

@@ -0,0 +1,6 @@
+.. autosummary::
+   :toctree: source/generated
+   :template:
+   :recursive:
+
+   DeepSDFStruct

docs/conf.py

@@ -0,0 +1,60 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "DeepSDFStruct"
+copyright = "2025, Michael Kofler"
+author = "Michael Kofler"
+
+# Try to get version from package, fallback to default if not installed
+try:
+    from importlib.metadata import version as package_version
+
+    release = str(package_version("DeepSDFStruct"))
+except Exception:
+    release = "latest"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "pydata_sphinx_theme"
+html_static_path = ["_static"]
+
+# -- Extensions --------------------------------------------------------------
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
+]
+
+
+autosummary_context = {"skipmethods": ["__init__"]}
+
+
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+    "show-inheritance": True,
+    "autosummary": True,
+}
+
+autodoc_typehints_format = "fully-qualified"  # show full package.module.Class
+autodoc_typehints_description_target = "all"  # document args + return types
+autodoc_typehints = "both"
+
+
+html_theme_options = {"collapse_navigation": False, "navigation_depth": 4}

docs/index.rst

@@ -0,0 +1,136 @@
+DeepSDFStruct Documentation
+===========================
+
+**DeepSDFStruct** is a differentiable framework for generating and deforming 3D microstructured materials using Signed Distance Functions (SDFs) and spline-based lattices. The library provides tools for creating, manipulating, and optimizing complex 3D geometries with applications in additive manufacturing, materials science, and computational design.
+
+Overview
+--------
+
+DeepSDFStruct combines classical geometric representations (SDFs, splines) with deep learning approaches to enable:
+
+* **Flexible Geometry Definition**: Define complex 3D structures using primitive shapes, lattice patterns, or learned implicit representations
+* **Differentiable Operations**: All operations are PyTorch-compatible, enabling gradient-based optimization
+* **Mesh Generation**: Extract high-quality surface and volume meshes using FlexiCubes and FlexiSquares algorithms
+* **Deep Learning Integration**: Train neural networks to represent and generate novel geometric structures
+* **Structural Optimization**: Optimize designs for specific mechanical properties or manufacturing constraints
+
+Key Features
+------------
+
+Signed Distance Functions (SDFs)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The core abstraction is the ``SDFBase`` class, which represents geometries as implicit functions that return the signed distance to the nearest surface. The library provides:
+
+* **Primitive Shapes**: Spheres, cylinders, boxes, tori, and other basic geometric primitives
+* **Lattice Structures**: Periodic microstructures with customizable unit cells
+* **Mesh-based SDFs**: Convert existing triangle meshes to SDF representations
+* **Deep Learning SDFs**: Neural network-based implicit representations trained from data
+* **Composition Operations**: Combine multiple SDFs using boolean operations (union, intersection, difference)
+
+Spline-based Deformations
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+DeepSDFStruct uses B-splines for smooth, parametric deformations:
+
+* **TorchSpline**: PyTorch-compatible spline evaluation for differentiable operations
+* **Parametrization**: Define spatially-varying material properties or geometry parameters
+
+Mesh Generation
+~~~~~~~~~~~~~~~
+
+Generate high-quality meshes from SDF representations:
+
+* **FlexiCubes**: Advanced dual contouring for smooth, feature-preserving surface meshes
+* **FlexiSquares**: 2D mesh extraction for cross-sections and planar geometries
+* **Volume Meshing**: Generate tetrahedral meshes for finite element analysis
+* **Mesh Processing**: Clean, repair, and optimize generated meshes
+
+Deep Learning Components
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Train neural networks to learn geometric representations:
+
+* **DeepSDF Architecture**: Multi-layer perceptron decoder for implicit geometry
+* **Hierarchical Models**: Multi-scale representations for complex structures
+* **Training Pipeline**: Complete workflow for dataset generation, training, and inference
+* **Latent Space Optimization**: Optimize learned representations for specific objectives
+
+Optimization and Analysis
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Tools for structural design and optimization:
+
+* **Gradient-based Optimization**: Leverage automatic differentiation for shape optimization
+* **MMA Optimizer**: Method of Moving Asymptotes for constrained optimization
+* **Finite Element Integration**: Interface with TorchFEM for structural analysis
+* **Design of Experiments**: Generate parameter sweeps and design spaces
+
+Core Modules
+------------
+
+* ``DeepSDFStruct.SDF``: Base classes for signed distance functions
+* ``DeepSDFStruct.mesh``: Mesh generation and processing utilities  
+* ``DeepSDFStruct.lattice_structure``: Periodic lattice structure generation
+* ``DeepSDFStruct.sdf_primitives``: Primitive geometric shapes
+* ``DeepSDFStruct.sampling``: Strategies for sampling points from SDFs
+* ``DeepSDFStruct.optimization``: Optimization algorithms and utilities
+* ``DeepSDFStruct.torch_spline``: PyTorch-compatible B-spline operations
+* ``DeepSDFStruct.parametrization``: Parametrization functions for spatially-varying properties
+* ``DeepSDFStruct.deep_sdf``: Deep learning models and training pipelines
+* ``DeepSDFStruct.flexicubes``: FlexiCubes mesh extraction algorithm
+* ``DeepSDFStruct.flexisquares``: FlexiSquares 2D mesh extraction
+* ``DeepSDFStruct.splinepy_unitcells``: Predefined unit cell geometries
+
+Installation
+------------
+
+Install directly from GitHub using pip::
+
+    pip install git+https://github.com/mkofler96/DeepSDFStruct.git
+
+Or add to your UV project::
+
+    uv add git+https://github.com/mkofler96/DeepSDFStruct.git
+
+Quick Start
+-----------
+
+Basic SDF operations::
+
+    import torch
+    from DeepSDFStruct.sdf_primitives import SphereSDF, CylinderSDF
+    from DeepSDFStruct.mesh import create_3D_mesh
+
+    # Create a sphere SDF
+    sphere = SphereSDF(center=[0, 0, 0], radius=0.5)
+    
+    # Query SDF values
+    points = torch.tensor([[0.0, 0.0, 0.0], [1.0, 0.0, 0.0]])
+    distances = sphere(points)
+    
+    # Generate mesh
+    mesh = create_3D_mesh(sphere, resolution=64)
+
+For more examples, see the `example notebook <https://github.com/mkofler96/DeepSDFStruct/blob/main/example.ipynb>`_.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api_reference
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+QR Codes to paper and Code
+------------
+Kofler, M., Giritsch, M. & Elgeti, S. Structural optimization of lattice structures using deep neural networks as geometry representation. Graphical Models 142, 101307 (2025). 
+.. image:: qr_code_paper.png
+
+Github Repository
+.. image:: qr_code_github.png 

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd