From 51a8389005ea77658e75ec7cfdab981224ab1893 Mon Sep 17 00:00:00 2001 From: Boris Kaus Date: Thu, 5 Oct 2023 16:43:06 +0200 Subject: [PATCH] update readme now that the package is registered --- README.md | 70 ++++++++++++++++++------------------------------------- 1 file changed, 23 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 171764c..a1ff36c 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,12 @@ # InteractiveGeodynamics.jl -This package provides a range of graphical user interfaces (GUI's) to study and experiment with different geodynamic problems without need to program. -It uses [julia](https://julialang.org) and [Dash](https://dash.plotly.com/julia) and automatically installs the required geodynamic software (such as [LaMEM](https://github.com/JuliaGeodynamics/LaMEM.jl)) in the background. -This is particularly useful as part of teaching. +This package provides a range of graphical user interfaces (GUI's) to study and experiment with different geodynamic problems without need to program. It uses [julia](https://julialang.org) and [Dash](https://dash.plotly.com/julia) and automatically installs the required geodynamic software (such as [LaMEM](https://github.com/JuliaGeodynamics/LaMEM.jl)) in the background. + +This is particularly useful for teaching. ### Getting started/requirements -In order to use this, you do need to install some software on your machine. -Please follow these steps if you haven't done this yet: -1) Install [Julia](https://julialang.org), which is a modern, high-level, scientific computer language that is open source, fast, and has a nice package manager. Please just download the precompiled binaries from their [webpage](https://julialang.org/downloads/). -2) Install [VSCode](https://code.visualstudio.com) by downloading the available binaries from the webpage. -3) Download [InteractiveGeodynamics.jl](https://github.com/JuliaGeodynamics/InteractiveGeodynamics.jl) to a directory of your choice on your machine by either: - a) Using `git clone https://github.com/JuliaGeodynamics/InteractiveGeodynamics.jl.git` (if you have git available in your terminal) - b) Or by going to the green `<> Code` button on the [webpage](https://github.com/JuliaGeodynamics/InteractiveGeodynamics.jl) and choosing the `Download ZIP` option (unzip it to a directory of your choice once it is downloaded) -4) Start julia by double-clicking the downloaded julia binary or by typing `julia` in your terminal . This will start the julia `REPL`( see https://docs.julialang.org/en/v1/stdlib/REPL/ for different modes): +Installing this is straightforward. Start with julia + ```julia kausb$ julia _ @@ -26,47 +20,22 @@ kausb$ julia julia> ``` -5) Type `;` to change to the shell mode. With `backspace` you can always get back to the REPL -```julia -shell> -``` -Let's assume that we downloaded `InteractiveGeodynamics.jl` to the directory `/Users/kausb/Downloads/InteractiveGeodynamics.jl` and that we want to run the example in `RayleighBenardConvection`: - -On linux/mac this is done with: -```julia -shell>cd /Users/kausb/Downloads/InteractiveGeodynamics.jl/RayleighBenardConvection -``` -On the windows powershell (accessible through VSCode) this can be done with: -``` -PS> cd C:\Users\boris\julia\dev\InteractiveGeodynamics.jl -``` -(Note that the directory will likely be different on your machine, so please adapt that) -Return to the `REPL` with the backspace. - - -6) Go to the package manager by pressing `]`. +1) Go to the package manager by pressing `]` and type: ```julia julia>] -(@v1.9) pkg> +(@v1.9) pkg> add InteractiveGeodynamics ``` -Then activate the package by typing `activate ../.` and hitting return: +2) Then download all required packages with ```julia -(@v1.9) pkg> activate ../. - Activating project at `~/Downloads/InteractiveGeodynamics.jl` (@v1.9) pkg> instantiate ``` -After that, type `instantiate` which will download the required packages you need. This can take some time the first time you do this. -```julia -(@v1.9) pkg> instantiate - ``` -Now return to the REPL by pressing `backspace`. -```julia -julia> - ``` -7) Start the GUI: +This can take some time the first time you do this. + +3) Start the GUI: ```julia -julia> include("Convection_Dash.jl") +julia> using InteractiveGeodynamics +julia> Convection() [ Info: Listening on: 127.0.0.1:8050, thread id: 1 ``` It will take a bit of time (to precompile/download all required packages) but it will start a GUI. After pushing `Run`, you'll get something that looks like this: @@ -86,10 +55,10 @@ Timestep 30 ### Running the examples -Running the other examples is reasonably straightforward. Every directory contains a julia file, so change to that directory and run the julia file with `include("NAME_Dash.jl")`. For example, the Rayleigh-Taylor example can be started with: +Running the other examples is straightforward. For example, the Rayleigh-Taylor example can be started with: ```julia -shell>cd RayleighTaylorInstability/ -julia> include("RTI_Dash.jl") +julia> using InteractiveGeodynamics +julia> RayleighTaylor() [ Info: Listening on: 127.0.0.1:8050, thread id: 1 Tiestep 0 args = -nstep_max 50 -eta[0] 1.0e21 -eta[1] 1.0e21 -eta[2] 1.0e20 -rho[0] 2800 -rho[1] 2800 -rho[2] 2200 -open_top_bound 0 -nel_x 32 -nel_z 16 -coord_x -5.0,5.0 @@ -102,3 +71,10 @@ Timestep 25 ``` ![GUI_RTI_start](./docs/src/assets/img/RTI_GUI_Dash.png) + +### Available examples +We currently have the following GUI's available: + +- `Convection()` +- `RisingSphere()` +- `RayleighTaylor()` \ No newline at end of file