grahamedwards / ComminWeath.jl

U-series comminution simulation and interpretation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ComminWeath.jl

Dev Build Status Coverage

Exploring the effects of comminution and weathering on the U-series systematics of sediments.

This package contains functions that simulate U-series comminution systematics of fine-grained sediments. The models incorporate replacement of detrital material with an insoluble authigenic "weathered" phase and implantation of U-series nuclides from a soluble authigenic rind.

This package accompanies a forthcoming manuscript... stay tuned!

Usage

The easiest way to use/explore the ComminWeath.jl package is through the examples.ipynb notebook (in the /examples directory), which runs on a JupyterHub server hosted by the Binder project:

Binder ←click this button to load

⚠️ This may be slow to load or require a few tries, please be patient ⚠️

Alternatively, the online Documentation details all of the contents of the package and their functionality.

Installation

To install ComminWeath.jl on your own computer, just type ] into the Julia REPL to enter the built-in package manager and then type add https://github.com/grahamedwards/ComminWeath.jl and hit enter.

After installing, just type using ComminWeath to use.

Visualizations

The easiest way to explore these codes is through the previously mentioned Binder notebook.

Alternatively, the examples/ folder contains a Jupyter notebook of examples (examples.ipynb) and accompanying suite of visualization functions (visualizations.jl). Downloading this directory or cloning the repository will allow you to run that notebook on your own computer.

A note for plotting on your own computer:

The visualization functions rely on the Makie.jl plotting package. If you wish to use any of these included plotting functions, you will need to install a Makie backend in your Julia environment. Makie has a couple of different backends available (e.g. CairoMakie, GLMakie).

I recommend CairoMakie for our purposes and include that as a package dependency for use in the Binder notebook. To install, just type ] into the Julia REPL to enter the built-in package manager and then type add CairoMakie (or your backend of choice) and hit enter. It may take a little bit of time to install. Then, before using any of the plotting functions, type using CairoMakie into the REPL (or notebook cell) and hit enter.


Please reach out to me if you have any questions or encounter any bugs!

About

U-series comminution simulation and interpretation

License:GNU General Public License v3.0


Languages

Language:Julia 100.0%