DifferentiableEvaporation

This code base is using the Julia Language and DrWatson to make a reproducible scientific project named

DifferentiableEvaporation

It is authored by Olivier Bonte.

To (locally) reproduce this project, do the following:

0. Download this code base. Notice that raw data are not included in the git-history and need to be downloaded independently (for more info on how to do so, the reader is referred to scripts/data_download/README.md). This is done easily with git:

   git clone https://github.com/olivierbonte/DifferentiableEvaporation
   

1. Make sure you have julia installed on your system. It is recommended to manage different julia versions with juliaup, which you can donwload here. This project is written in Julia 1.10.9, which you can add in juliaup with the following command:

   juliaup add 1.10.9
   

2. Nex navigate to the folder DifferentiableEvaporation and open Julia by running

   julia
   

   or specifically the 1.10.9 version if you're using juliaup:

   julia +1.10.9
   

   and then do the following:

   julia> using Pkg
   julia> Pkg.add("DrWatson") # install globally, for using `quickactivate`
   julia> using DrWatson
   julia> @quickactivate "DifferentiableEvaporation"
   julia> Pkg.instantiate()
   

This will install all necessary packages for you to be able to run the scripts and everything should work out of the box, including correctly finding local paths. To avoid dependency conflicts, it is recommend to use the Julia version given in the compat section of Project.toml.

You may notice that most scripts start with the commands:

using DrWatson
@quickactivate "DifferentiableEvaporation"

which auto-activate the project and enable local path handling from DrWatson.

Note that Julia scripts (.jl) which have the following header:

### A Pluto.jl notebook ###

are Pluto Notebooks. You can run these as regular Julia scripts from the REPL, but you can also activate a notebook interface (which will open in a web browser). To do so, first activate the computational environment with DrWatson (see Julia snippet above), and then use:

import Pluto
Pluto.run()

Subsequently, you can choose your notebook of choice to open.

Besides Julia, also Python is used in this project. The required dependencies to run the python code is given in environment.yml. Install via (Mini)conda or Mamba (in this case, replace conda by mamba in the command below) in the command line interface:

conda env create -f environment.yml
conda activate DifferentiableEvaporation

Data processing

For more information on the data processing, follow the instructions in the folders in the order given below:

1. Data download information, see here
2. Data processing information, see here