/HydrologyPlanetesimals.jl

Julia package for simulating the hydrology of planetesimals

Primary LanguageJuliaMIT LicenseMIT

HydrologyPlanetesimals

CI Stable Dev Coverage Code Style: Blue ColPrac: Contributor's Guide on Collaborative Practices for Community Packages

DOI

Julia package to simulate the hydrology in planetesimals1.

A MSc project at ETH Zurich under the supervision of Taras Gerya (ETH Zurich) and Tim Lichtenberg (University of Oxford).

Usage

Installation

At the Julia prompt, add with using Pkg; pkg"add https://github.com/BeatHubmann/HydrologyPlanetesimals.jl".

Parameters

Adjust the simulation parameters in src/constants.jl if necessary. A set of parameters suitable for unit testing is given at src/test_constants.jl.

Running the simulation

Launch with julia -O3 --tauto launch.jl /PATH/TO/OUTPUT/. All intermediate data is written into HDF-5 compatible .jld2 files in the output directory for further analysis and plotting.

Relevant simulation progress and used parameters are written to the log file HydrologyPlanetesimals_run.log in the output directory.

Plotting results

Generate plots with julia generate_plots.jl /PATH/TO/OUTPUT/; .pdf plot files are stored in same directory as the simulation output. Generate animations with julia generate_animations.jl /PATH/TO/OUTPUT/; .mp4 animation files are stored in same directory as the simulation output.

Footnotes

  1. Based on: Gerya, T. (2019). Introduction to Numerical Geodynamic Modelling (2nd ed.). Cambridge: Cambridge University Press, doi:10.1017/9781316534243.