updated readme

cerea-daml · Jan 19, 2023 · c018574 · c018574
1 parent 4d1c751
commit c018574
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -12,17 +12,19 @@ by Marc Bocquet.
 
 ## Installation
 
-Clone the repertory with HTTPS (cloning with SSH is not allowed outside ENPC).
+Install conda, for example through [miniconda](https://docs.conda.io/en/latest/miniconda.html) or through [mamba](https://mamba.readthedocs.io/en/latest/installation.html).
 
-    $ git clone https://gitlab.enpc.fr/alban.farchi/tp-data-assimilation.git
+Clone the repertory:
+
+    $ git clone [email protected]:cerea-daml/adomo-mocis-wape-daml-tutorial.git
 
 Go to the repertory. Once there, create a dedicated anaconda environment for the sessions:
 
     $ conda env create -f environment.yaml
 
 Activate the newly created environment:
 
-    $ conda activate da-tp-sw
+    $ conda activate tutorial
 
 [Optional] Update the environment:
 
@@ -34,4 +36,5 @@ Activate the newly created environment:
 
 Open the notebook (e.g. with Jupyter) and follow the instructions:
 
-    $ jupyter-notebook tp-shallow-water.ipynb
+    $ jupyter-notebook tutorial.ipynb
+
diff --git a/environment.yaml b/environment.yaml
@@ -1,11 +1,11 @@
-name: da-tp-sw
+name: tutorial
 channels:
   - defaults
 dependencies:
-  - jupyter lab
   - numpy
-  - matplotlib
-  - tqdm
   - numba
+  - matplotlib
   - seaborn
+  - tqdm
+  - jupyterlab
   - ipywidgets
diff --git a/tp-shallow-water.ipynb → tutorial.ipynb b/tp-shallow-water.ipynb → tutorial.ipynb