Welcome to pyLattice’s documentation!

pyLattice is a comprehensive Python toolkit for designing, analyzing, and simulating lattice structures. The package provides capabilities for:

• Lattice Generation: Create various lattice geometries (BCC, Octet, Kelvin, etc.)

• Visualization: Interactive 3D plotting with matplotlib or Plotly

• Finite Element Analysis: Structural simulations using FEniCSx

• Mesh Operations: Advanced geometry trimming and manipulation

• Optimization: Topology and parameter optimization tools

Getting Started

1. Follow the 📘 Installation Guide to set up your environment

2. Check out the 📚 Examples for practical usage scenarios

3. Learn about 🔷 Geometry Definitions for Lattice Structures to create custom unit cells

4. Explore the API documentation in src

User Guide:

• 📘 Installation Guide
  • Overview
  • 1. Prerequisites
  • 2. Create a Conda Environment
  • 3. Install Core Dependencies
  • 4. Install Optional Dependencies
  • 5. Optional: Verify Installation
  • 6. Example Usage
• 📚 Examples
  • 🔵 Basic Lattice Generation
  • 🔧 Mesh Operations
  • 🧮 Finite Element Simulation
  • 🚀 Optimization
  • 💾 Data Management
  • 📐 Custom Geometries
  • 🛠️ Advanced Usage
• 🔷 Geometry Definitions for Lattice Structures
  • 📁 Structure of Geometry Files
  • ⚙️ Parametric Geometries
  • 🔁 Random Geometry Option
  • ➕ Adding a New Geometry
• Boundary Conditions — Configuration Guide
  • Minimal JSON example
  • Structure of the boundary_conditions block
  • Surface selection
  • DOF mapping
  • Reading the example, step by step
  • Best practices
  • Quick troubleshooting
• MeshTrimmer Class
  • 📦 Features
  • 🧰 Dependencies
  • 🧱 Class Usage
  • 🧩 Methods
  • 🧬 Integration with Lattice
  • 📁 File Structure Convention
  • 🛠️ Limitations

API Reference:

• src
  • pyLattice packages

Indices and tables

• Index

• Module Index

• Search Page