User Guide

User Guide#

This section provides an overview of the components of the Cratermaker package, with several examples to demonstrate how each component works.

Components of Cratermaker#

Simulation

This is main class that can be used to run a comprehensive cratered landscape evolution model.

Simulation
Surface

Represents the surface of the target body, including its resolution, topography, material properties.

Surface
Surface

Represents the surface of the target body, including its resolution, topography, material properties.

Surface
Morphology

Used to construct the three-dimensional representation of a crater onto the surface.

Morphology
Morphology

Used to construct the three-dimensional representation of a crater onto the surface.

Morphology
Production

Manages the production function, which determines the number of craters/projectiles produced over time and surface area.

Production
Counting

Contains methods for counting craters on the surface.

Counting
Counting

Contains methods for counting craters on the surface.

Counting
Target

Models the properties of the target body, including its size, material properties, and surface gravity.

Target
Projectile

Models the properties of projectiles, including their size, velocity, and density.

Projectile
Scaling

Contains the model for relating projectile size and crater size.

Scaling
Scaling

Contains the model for relating projectile size and crater size.

Scaling
Crater

Contains the model for relating projectile size and crater size.

Crater
Exporting and Visualization

Visualizing data and exporting it to different formats for use with other tools.

Visualizing the surface
Example gallery

See full working examples of how to use Cratermaker.

Example Gallery
API reference

The API guide contains a detailed description of the Cratermaker API. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts.

Cratermaker API reference
API reference

The API guide contains a detailed description of the Cratermaker API. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts.

Cratermaker API reference