Docs fix (#50)

* Docs cosmetics * Fix installation instructions
CWorthy-ocean · Jul 9, 2024 · 9908bde · 9908bde
1 parent 82110a7
commit 9908bde
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -28,7 +28,7 @@ You can install and activate the following conda environment::
 
     cd roms-tools
     conda env create -f ci/environment.yml
-    conda activate romstools-test
+    conda activate romstools
 
 This conda environment is useful for any of the following steps:
 
@@ -41,7 +41,7 @@ Running the tests
 
 You can check the functionality of the ROMS-Tools code by running the test suite::
 
-    conda activate romstools-test
+    conda activate romstools
     cd roms-tools
     pytest
 
@@ -52,7 +52,7 @@ Contributing code
 If you have written new code, you can run the tests as described in the previous step. You will likely have to iterate here several times until all tests pass.
 The next step is to make sure that the code is formatted properly. Activate the environment::
 
-    conda activate romstools-test
+    conda activate romstools
 
 You can now run all the linters with::
 
@@ -67,7 +67,7 @@ Building the documentation locally
 
 Activate the environment::
 
-    conda activate romstools-test
+    conda activate romstools
 
 Then navigate to the docs folder and build the docs via::
 

diff --git a/docs/methods.rst b/docs/methods.rst
@@ -1,6 +1,8 @@
 Methodology
 ===========
 
+The ROMS-Tools methodology closely follows the methods employed in the `UCLA MATLAB tools <https://github.com/nmolem/ucla-tools/tree/main>`_.
+
 Grid
 #####