From 3b16dd515d170ed3b515886526dc6e112a75d8f8 Mon Sep 17 00:00:00 2001 From: Boris Kaus Date: Sun, 20 Nov 2022 19:08:02 +0100 Subject: [PATCH] fix readme --- README.md | 47 ----------------------------------------------- 1 file changed, 47 deletions(-) diff --git a/README.md b/README.md index c73ae31..8121038 100644 --- a/README.md +++ b/README.md @@ -45,53 +45,6 @@ Time stepping parameters: ``` The last parameter are optional PETSc command-line options. By default it runs on one processor. -# LaMEM.jl -[![Build Status](https://github.com/JuliaGeodynamics/LaMEM.jl/workflows/CI/badge.svg)](https://github.com/JuliaGeodynamics/LaMEM.jl/actions) -[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliageodynamics.github.io/LaMEM.jl/dev/) - -This is the Julia interface to [LaMEM](https://bitbucket.org/bkaus/lamem) (Lithosphere and Mantle Evolution Model), which is the easiest way to install LaMEM on any system, allows you to start a (parallel) LaMEM simulation, and read back the output files to julia for further processing. - -### 1. Installation -Go to the package manager & install it with: -```julia -julia>] -pkg>add LaMEM -``` -It will automatically download a binary version of LaMEM which runs in parallel (along with the correct PETSc version). This will work on linux, mac and windows. - -### 2. Starting a simulation -As usual, you need a LaMEM (`*.dat`) input file, which you can run in parallel (here on 4 cores) with: -```julia -julia> ParamFile="input_files/FallingBlock_Multigrid.dat"; -julia> run_lamem(ParamFile, 4,"-time_end 1") --------------------------------------------------------------------------- - Lithosphere and Mantle Evolution Model - Compiled: Date: Sep 10 2022 - Time: 06:21:30 --------------------------------------------------------------------------- - STAGGERED-GRID FINITE DIFFERENCE CANONICAL IMPLEMENTATION --------------------------------------------------------------------------- -Parsing input file : input_files/FallingBlock_Multigrid.dat - Adding PETSc option: -snes_type ksponly - Adding PETSc option: -js_ksp_monitor - Adding PETSc option: -crs_pc_type bjacobi -Finished parsing input file : input_files/FallingBlock_Multigrid.dat --------------------------------------------------------------------------- -Time stepping parameters: - Simulation end time : 1. [ ] - Maximum number of steps : 10 - Time step : 10. [ ] - Minimum time step : 1e-05 [ ] - Maximum time step : 100. [ ] - Time step increase factor : 0.1 - CFL criterion : 0.5 - CFLMAX (fixed time steps) : 0.5 - Output time step : 0.2 [ ] - Output every [n] steps : 1 - Output [n] initial steps : 1 --------------------------------------------------------------------------- -``` -The last parameter are optional PETSc command-line options. By default it runs on one processor. - Please note that you will have to be in the correct directory (the same one as where the LaMEM parameter file is located). If you are in a different directory, the easiest way to change to the correct one is by using the build-in terminal/shell in julia, which you can access with: ```julia julia>;