examples

PolytopAX Examples

This directory contains practical examples demonstrating how to use PolytopAX for various computational geometry tasks.

Directory Structure

examples/
├── basic/              # Basic usage examples
├── advanced/          # Advanced techniques and optimization
├── notebooks/         # Jupyter notebook tutorials
└── README.md         # This file

Basic Examples

Perfect for getting started with PolytopAX:

• basic_convex_hull.py - Simple 2D and 3D convex hull computation
• point_inclusion.py - Testing if points are inside convex hulls
• geometric_properties.py - Computing volume, surface area, centroid
• jax_integration.py - Using JAX transformations (jit, grad, vmap)

Advanced Examples

For experienced users and specific applications:

• batch_processing.py - Efficient batch operations
• differentiable_optimization.py - Gradient-based optimization
• custom_algorithms.py - Building custom convex hull algorithms
• performance_optimization.py - Performance tuning and benchmarking

Jupyter Notebooks

Interactive tutorials with visualizations:

• 01_introduction.ipynb - Introduction to PolytopAX
• 02_differentiable_hulls.ipynb - Understanding differentiable convex hulls
• 03_optimization_examples.ipynb - Optimization problems using convex hulls
• 04_performance_analysis.ipynb - Performance analysis and comparisons

Running the Examples

Python Scripts

# Navigate to the examples directory
cd examples

# Run a basic example
python basic/basic_convex_hull.py

# Run an advanced example
python advanced/batch_processing.py

Jupyter Notebooks

# Install jupyter if not already installed
pip install jupyter matplotlib

# Start jupyter notebook
jupyter notebook

# Open any .ipynb file in the notebooks/ directory

Requirements

Most examples require only the base PolytopAX installation:

pip install polytopax

Some advanced examples may require additional packages:

pip install matplotlib scipy plotly  # For visualization
pip install optax                     # For optimization examples

Contributing Examples

We welcome contributions of new examples! Please:

1. Follow the existing code style and structure
2. Include clear comments and docstrings
3. Add appropriate error handling
4. Test your examples thoroughly
5. Update this README if adding new categories

Getting Help

If you have questions about any examples:

• Check the documentation
• Open an issue on GitHub
• Join our community discussions

Happy computing with PolytopAX! 🚀