Astroshaper-examples

Example code for Astroshaper packages.

Overview

This repository contains example notebooks demonstrating the use of AsteroidThermoPhysicalModels.jl for thermophysical modeling of asteroids.

Installation

1. Install Julia (1.10 or later recommended)
2. Clone this repository:

   git clone https://github.com/Astroshaper/Astroshaper-examples.git
   cd Astroshaper-examples

3. Navigate to the desired example directory and follow the instructions in its README

Available Examples

TPM_Ryugu

Thermophysical modeling (TPM) calculation for asteroid Ryugu.

• Single asteroid TPM
• Temperature distribution analysis
• Non-gravitational forces calculation
• Compatible with: AsteroidThermoPhysicalModels.jl v0.2.1 (see CHANGELOG.md for older versions)

TPM_Didymos

TPM calculation for the binary asteroid system Didymos.

• Binary asteroid TPM
• Mutual shadowing (eclipses)
• Mutual heating between primary and secondary
• Compatible with: AsteroidThermoPhysicalModels.jl v0.2.1 (see CHANGELOG.md for older versions)

TPM_Kanamaru2021

Example notebook for YORP simulation in Kanamaru et al. (2021).

• YORP effect calculation
• Long-term rotational evolution
• Compatible with: AsteroidThermoPhysicalModels.jl v0.0.4 only (not yet migrated)

Running the Examples

Each example directory contains:

• A Jupyter notebook (.ipynb file)
• A Project.toml file specifying dependencies
• A README with specific instructions

To run an example:

1. Navigate to the example directory
2. Start Julia and activate the project:

   using Pkg
   Pkg.activate(".")
   Pkg.instantiate()

3. Launch Jupyter:

   using IJulia
   notebook()

4. Open and run the notebook

Requirements

• Julia 1.10 or later
• Jupyter (via IJulia.jl)
• Internet connection for downloading shape models and ephemeris data

License

These examples are provided under the same license as AsteroidThermoPhysicalModels.jl.

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.