Doc update

README.md

@@ -10,27 +10,32 @@ Fimbul.jl is a [Julia](https://julialang.org/)-based toolbox for geothermal simu
 ## Getting started
 
 To get started with Fimbul, install [Julia](https://julialang.org/) and follow these steps:
-- Clone Fimbul
+- Clone JutulDarcy and Fimbul
 ```bash
+git clone https://github.com/sintefmath/JutulDarcy.jl.git
 git clone https://github.com/sintefmath/Fimbul.jl.git
 ```
+NOTE: Fimbul currently relies on the development version of JutulDarcy, and this repository therefore has to be cloned as well. This will likely change in a future release, so that the release version of JutulDarcy can be used instead.
 - Make a project folder in a suitable location and navigate to it
 ```bash
 mkdir fimbul-testing
 cd fimbul-testing/
 ```
-- Start a Julia REPL in the project folder, activate an environment, and add Fimbul. As this is still in a pre-release state, you have to dev it,
+- Start a Julia REPL in the project folder, activate an environment, and add Fimbul and JutulDarcy. We will use the development versions that we just cloned.
 ```julia
 using Pkg; Pkg.activate(".");
-Pkg.dev("path/to/Fimbul/"); Pkg.instantiate()
+Pkg.develop(path="path/to/JutulDarcy/");
+Pkg.develop(path="path/to/Fimbul/");
+Pkg.instantiate()
 ```
+
 You are now ready to run your first simulation! Fimbul comes with a number of example cases for geothermal energy applications. To check that everything works, you can run a small geothermal doublet case:
 ```julia
-using Fimbul
+using Fimbul, JutulDarcy
 using GLMakie
 case = egg_geothermal_doublet()
-results = simulate_reservoir(case)
+result = simulate_reservoir(case)
 plot_reservoir(case, result.states;
-colormap = :seaborn_icefire_gradient, key = :Temperature, step = length(case.dt))
+colormap = :seaborn_icefire_gradient, key = :Temperature)
 ```
-Note that interactive plotting requires GLMakie, which may not work if you are running Julia over SSH.
+Note that interactive plotting requires `GLMakie`, which may not work if you are running Julia over SSH.

docs/src/index.md

@@ -25,30 +25,35 @@ Fimbul.jl is a [Julia](https://julialang.org/)-based toolbox for geothermal simu
 ## Getting started
 
 To get started with Fimbul, install [Julia](https://julialang.org/) and follow these steps:
-- Clone Fimbul
+- Clone JutulDarcy and Fimbul
 ```bash
+git clone https://github.com/sintefmath/JutulDarcy.jl.git
 git clone https://github.com/sintefmath/Fimbul.jl.git
 ```
+NOTE: Fimbul currently relies on the development version of JutulDarcy, and this repository therefore has to be cloned as well. This will likely change in a future release, so that the release version of JutulDarcy can be used instead.
 - Make a project folder in a suitable location and navigate to it
 ```bash
 mkdir fimbul-testing
 cd fimbul-testing/
 ```
-- Start a Julia REPL in the project folder, activate an environment, and add Fimbul. As this is still in a pre-release state, you have to dev it,
+- Start a Julia REPL in the project folder, activate an environment, and add Fimbul and JutulDarcy. We will use the development versions that we just cloned.
 ```julia
 using Pkg; Pkg.activate(".");
-Pkg.dev("path/to/Fimbul/"); Pkg.instantiate()
+Pkg.develop(path="path/to/JutulDarcy/");
+Pkg.develop(path="path/to/Fimbul/");
+Pkg.instantiate()
 ```
+
 You are now ready to run your first simulation! Fimbul comes with a number of example cases for geothermal energy applications. To check that everything works, you can run a small geothermal doublet case:
 ```julia
-using Fimbul
+using Fimbul, JutulDarcy
 using GLMakie
 case = egg_geothermal_doublet()
-results = simulate_reservoir(case)
+result = simulate_reservoir(case)
 plot_reservoir(case, result.states;
-colormap = :seaborn_icefire_gradient, key = :Temperature, step = length(case.dt))
+colormap = :seaborn_icefire_gradient, key = :Temperature)
 ```
-Note that interactive plotting requires GLMakie, which may not work if you are running Julia over SSH.
+Note that interactive plotting requires `GLMakie`, which may not work if you are running Julia over SSH.
 
 ## Working with Fimbul
 If you plan to use Fimbul extensively in your work, we strongly recommend that you read the documentation of [JutulDarcy](https://sintefmath.github.io/JutulDarcy.jl/dev/), in particular on [getting started](https://sintefmath.github.io/JutulDarcy.jl/dev/man/intro). This also covers the basics of installing Julia and creating a Julia environments, written for users who may not already be familiar with Julia package management.