소스 검색

Update doc

Pierre-Yves Barriat 2 년 전
부모
커밋
e617adbd59
2개의 변경된 파일72개의 추가작업 그리고 0개의 파일을 삭제
  1. 72 0
      README.md
  2. BIN
      images/run_example.png

+ 72 - 0
README.md

@@ -16,3 +16,75 @@ plasim/doc for the Planet Simulator
 
 Then have a look at the README file for configuration and setup.
 
+## Installation
+
+### coriolis
+
+```bash
+cd /cofast/$USER
+git clone https://gogs.elic.ucl.ac.be/TECLIM/PlaSim.git
+
+cd PlaSim
+./configure.sh
+```
+
+## Quick run
+
+```bash
+cd /cofast/$USER/PlaSim
+./most.x
+```
+
+Example:
+
+- Select model "Planet Simulator"
+- Select modules "ML Ocean" and "Sea Ice"
+- Edit number of cores (eg 16)
+- Switch GUI off
+- Switch Output on
+- Switch "Double Precision" on
+- Edit number of years to run
+- Click on `Save & Exit`
+
+See the corresponding example below:
+
+![MoSt example](./images/run_example.png)
+
+Now, launch the model:
+
+```bash
+cd plasim/run
+screen
+./most_plasim_run
+```
+
+> You can leave the `screen` process with
+
+```bash
+Ctrl+a d
+```
+
+> You can monitor the model process with
+
+```bash
+cat plasim_diag | grep Completed
+```
+
+Results are:
+
+```bash
+209M  MOST.001
+4,1M  MOST_REST.001
+249K  MOST_DIAG.001
+5,3M  MOST_OCE.001.nc
+ 14M  MOST_ICE.001.nc
+ 69M  ice_output
+209M  MOST.002
+ 29M  ocean_output
+4,1M  MOST_REST.002
+245K  MOST_DIAG.002
+5,2M  MOST_OCE.002.nc
+ 15M  MOST_ICE.002.nc
+4,1M  plasim_restart
+```
+

BIN
images/run_example.png