Welcome to Polyhedral Gravity Model’s documentation!

Have a look at the INSTALLATION & QUICK START section to quickly get into the use of the polyhedral gravity model.

And for more details, refer to the Python API or C++ API.

INSTALLATION & QUICK START

• Installation
  • Installation with conda
  • Installation with pip
  • Installation & Build from source
• Quick Start (C++ & Python)
  • Gravity Model Input
  • Gravity Model Output
• Supported Polyhedron Source Files
• Examples Python
  • Free function
  • GravityEvaluable
• Examples C++
  • As Executable
  • As Library

BACKGROUND

• Statement of Need
  • The Rational
  • References
• Implementation’s Details
• Mesh Integrity & Explanation
• GravityEvaluable vs. Evaluate Function

PYTHON API REFERENCE

• Python API - polyhedral_gravity
  • Module Overview
  • Polyhedron
  • GravityModel

C++ API REFERENCE

• Model
  • Overview
  • Polyhedron
  • GravityModel
  • Named Tuple
• Input
  • Overview
  • Abstract Interfaces
  • Implementations
• Output
  • Overview
  • Implementations
• Util
  • Overview
  • Documentation

Indices and tables

• Index

• Module Index

• Search Page