update README

jnywong · Jul 6, 2021 · c9fb2b8 · c9fb2b8
1 parent 6360611
commit c9fb2b8
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ Python package to process data from PARODY-JA4.3 dynamo simulations.
 
 ### Prerequisites
 - [Python3](https://www.python.org/)
+- [SHTns](https://bitbucket.org/nschaeff/shtns/src/master/)
+- [ChaosMagPy](https://github.com/ancklo/ChaosMagPy)
 
 ### Installing
 Conda:
@@ -22,15 +24,13 @@ Git:
 
 Find the Git repo [here](https://github.com/jnywong/nondim-slurry).
 
-#### IPython issue
+#### Warning: IPython issue
 Please note that ipython may not be compatible with jedi release 0.18.0. Please revert to version 0.17.2 for auto-complete features to work (see [here](https://github.com/ipython/ipython/issues/12740)).
 
 ## Package structure
 ```
 paropy/
-  LICENSE.md
-  MANIFEST.in
-  README.md
+  docs/
   paropy/
     __init__.py
     data_utils.py
@@ -48,9 +48,11 @@ paropy/
       rotation_rate.py
       surface_snapshot.py
       surface_timeavg.py
-
     data/
       CHAOS-7.7.mat
+  LICENSE.md
+  MANIFEST.in
+  README.md
   setup.py
 ```
 
@@ -67,6 +69,7 @@ Example scripts can be found within the module `paropy`.
 ```
 run_ID = <run_ID> # PARODY simulation tag
 directory = <path_to_data>
+saveDir = <path_to_savefigs>
 ```
 
 3. Run `paropy/scripts/diagnostics.py`
@@ -81,37 +84,33 @@ directory = <path_to_data>
 
 1. Open `paropy/scripts/meridional_snapshot.py`
 
-2. Set path to simulation data by setting
+2. Set path to simulation data and snapshot time by setting
 
 ```
-run_ID = <run_ID> # PARODY simulation tag
+run_ID, timestamp = 'c-200a', '16.84707134'
 directory = <path_to_data>
 ```
 
-3. Specify timestamp of snapshot by setting `timestamp`
+3. Run `paropy/scripts/meridional_snapshot.py`
 
-4. Run `paropy/scripts/meridional_snapshot.py`
-
-5. Admire the output:
+4. Admire the output:
 
 ![](https://raw.githubusercontent.com/jnywong/paropy/master/docs/merid_test.png)
 
 ### Surface snapshots
 
 1. Open `paropy/scripts/surface_snapshot.py`
 
-2. Set path to simulation data by setting
+2. Set path to simulation data and snapshot time by setting
 
 ```
-run_ID = <run_ID> # PARODY simulation tag
+run_ID, timestamp = 'c-200a', '16.84707134'
 directory = <path_to_data>
 ```
 
-3. Specify timestamp of snapshot by setting `timestamp`
+3. Run `paropy/scripts/surface_snapshot.py`
 
-4. Run `paropy/scripts/surface_snapshot.py`
-
-5. Admire the output:
+4. Admire the output:
 
 ![](https://raw.githubusercontent.com/jnywong/paropy/master/docs/surface_test.png)
 
@@ -120,6 +119,10 @@ directory = <path_to_data>
 * [PyPI](https://pypi.org/project/paropy/)
 * [Anaconda Cloud](https://anaconda.org/jnywong/paropy)
 
+## Data
+
+* CHAOS-7.7 [(Finlay et al. 2020)](http://www.spacecenter.dk/files/magnetic-models/CHAOS-7/CHAOS-7.pdf)
+
 ## Authors
 
 * [**Jenny Wong**](https://jnywong.github.io/) - *Institut de Physique du Globe de Paris - Institut des Sciences de la Terre*

diff --git a/docs/merid_test.png b/docs/merid_test.png
diff --git a/paropy/scripts/surface_snapshot.py b/paropy/scripts/surface_snapshot.py
@@ -9,7 +9,7 @@
 
 Loads core surface data and plots core surface field snapshot.
 
-ATTENTION: Folder structure should be of the form `<folder>/<run_ID>/Gt_*.run_ID`
+ATTENTION: Folder structure should be of the form `<folder>/<run_ID>/St_*.run_ID`
 """
 
 import os
@@ -25,13 +25,11 @@
 #%%--------------------------------------------------------------------------%%
 # INPUT PARAMETERS
 #----------------------------------------------------------------------------%%
-run_ID = 'chem_200d' # PARODY simulation tag
+run_ID, timestamp = 'c-200a', '16.84707134'
 directory = '/data/geodynamo/wongj/Work/{}'.format(run_ID) # path containing simulation output
 # directory = '/Volumes/NAS/ipgp/Work/{}/'.format(run_ID)
 # directory = '/Users/wongj/Desktop/data/{}'.format(run_ID)
 
-timestamp = '6.648476379'
-
 fig_aspect = 1 # figure aspect ratio
 n_levels = 60 # no. of contour levels