more docs

raphaeldussin · Nov 25, 2018 · 1b8d332 · 1b8d332
1 parent ca861e8
commit 1b8d332
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -11,6 +11,7 @@ interimR: an interim foRcing package!
    :caption: Contents:
 
    install
+   usage
 
 
 Indices and tables

diff --git a/doc/usage.rst b/doc/usage.rst
@@ -0,0 +1,25 @@
+Usage
+-----
+
+Setting up your interimR
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+interimR is installing configuration files into $HOME/.interimR
+
+Open the user.opts and add a new entry corresponding to your setup.
+You can add as many entry as you need.
+
+Commands
+^^^^^^^^
+
+* get forcing files for the chosen period in your entry::
+    interimR-get-ERAinterim <your-entry>
+
+* get land/sea mask::
+    interimR-get-maskERAinterim <your-entry>
+
+* process ERAinterim::
+    interimR-process-ERAinterim <your-entry>
+
+* process DFS 5.2::
+    interimR-process-DFS52 <your-entry>