This repository contains the R and Julia scripts used to generate the results and create the plots found in Smith & Sinapayen, 2024 (https://arxiv.org/abs/2403.14195).

The simulation data is available without rerunning on figshare: https://figshare.com/articles/dataset/2024-03-12-175828_zip/25515067

Running Julia \scripts

• Install Julia (https://julialang.org/downloads/)
• Clone this repo (or a forked version) to your machine
• Navigate to the repo directory, and into \scripts
• Start the Julia REPL from your terminal (julia)

julia> 

• Access Julia's package mode by hitting the ] key.

  julia> ]

  Note: You will notice your promt change from julia> to (@v1.6) pkg> , or whatever your version of Julia is.

  (@v1.6) pkg> 

  Note: This is Julia's powerful Pkg manager, you can learn more about it here.

  Note: You can also access shell from within Julia by hitting ; instead of ].

• Next we will activate our environment. This is kind of like a virtual environment within python--this allows for us to install packages at specific versions for this particular project without affecting other projects.

  (@v1.6) pkg> activate .

  Note: You'll notice your prompt switch to the directory/repo name, to let you know you're in this environment.

  (scripts) pkg>

• add the TerraformingAgents package via it's GitHub URL and verson number.

  (scripts) pkg> add https://github.com/hbsmith/TerraformingAgents#0.1.0

  Note: This is the only package that must be manually installed, because it is not registered in the Julia package registry.

• Then we instantiate. This means that Julia looks at the packages required by the project (inside the Project.toml file), and installs all of them.

  (scripts) pkg> instantiate

Setup tl;dr

# from /scripts
julia> ]activate .

(scripts) pkg> add https://github.com/hbsmith/TerraformingAgents#0.1.0

(scripts) pkg> instantiate

Now you're ready to run the two scripts...

run_simulation_parallel.jl

This generates the data used in all analyses in Smith & Sinapayen, 2024. By default, the data will create a directory called output in a directory where the TerraformingAgents package is. On macOS, this will be somewhere like, /Users/me/.julia/packages/TerraformingAgents/WyHKo/output. Note that it can take a few hours to run depending on the number of cores allocated, and the total data size will be ~2.3GB. The already generated data is available on figshare: https://figshare.com/articles/dataset/2024-03-12-175828_zip/25515067

To run, simply navigate to the /scripts directory and:

% julia
julia> include("run_simulation_parallel.jl")

NplanetsVsMantelAtSTD.jl

This generates the Figure A3 in Smith & Sinapayen, 2024. By default, the plot will be output to the system GUI.

% julia
julia> include("NplanetsVsMantelAtSTD.jl")
julia> main()

Data analysis using R

The analysis folder contains the R scripts used to generate figures in the paper. We recommend using RStudio for the best experience.

Install R and RStudio

RStudio is and IDE for R. Both can be installed from these instructions: https://posit.co/download/rstudio-desktop/

Run the notebooks

Each .Rmd notebook has a couple of variables to specify the path to your data folder:

base_path = "../scripts/example_data/"
sub_folder = "2024-03-12-175828/"

base_path is the path where all data is and where figures will be saved. sub_folder is the folder whith the one dataset you wish to analyse.

Run the analysis step by step according to your needs.

Some libraries may be required to run some of the scripts. RStudio will prompt you to install them.