VoxCity Tutorial Notebooks¶

Welcome to the VoxCity tutorials! These notebooks will guide you through generating 3D voxel-based urban models and running various urban simulations.

🚀 Getting Started¶

Notebook	Description	Difficulty
demo_quickstart	Start here! Quick 5-minute introduction with automatic data source selection	⭐ Beginner
demo_basic	Complete guide to all features, data sources, and options	⭐⭐ Intermediate
demo_data_sources	Comprehensive overview of all available data sources	⭐⭐ Intermediate

🔬 Urban Simulations¶

Notebook	Description	Applications
demo_solar	Solar irradiance analysis (ground & building surfaces)	Energy, comfort, shading
demo_view	Green View Index & Sky View Index	Walkability, urban greening
demo_landmark	Landmark visibility analysis	Planning, tourism, heritage

🎨 Visualization & Export¶

Notebook	Description	Output Formats
demo_3d_visualization	3D rendering options and simulation overlays	Images, interactive views
demo_obj	Export to OBJ format for 3D software	Blender, Rhino, SketchUp
demo_envi-met	Export to ENVI-met INX format	CFD simulations

📚 Learning Path¶

For Beginners¶

Start with demo_quickstart to generate your first model
Explore demo_3d_visualization to see your model in 3D
Try demo_view for a simple simulation

For Advanced Users¶

Read demo_data_sources to understand all options
Follow demo_basic for full control
Use demo_solar for detailed irradiance analysis
Export with demo_envi-met for CFD workflows

🌐 Data Requirements¶

Most tutorials require Google Earth Engine access for downloading geospatial data. See the data sources notebook for:

Authentication instructions
Available data sources by region
Offline alternatives

💡 Tips¶

Start small: Use areas under 500m × 500m while learning
Mesh size: 5m is a good default; use 2-3m for detail, 10m for large areas
Save your work: Use save_voxcity() to avoid re-downloading data

Tutorials: