Merge pull request #72 from ACCESS-NRI/v0.0.4

Release v0.0.4
ACCESS-NRI · May 17, 2023 · f069985 · f069985
2 parents 76fdede + a07fb99
commit f069985
Show file tree

Hide file tree

Showing 10 changed files with 1,413 additions and 1,458 deletions.
diff --git a/README.rst b/README.rst
@@ -4,7 +4,7 @@ ACCESS-NRI Intake Catalog
 
 **Tools and configuration info used to manage ACCESS-NRI's intake catalog**
 
-Note, this is under development. Things might change/break frequently and without warning.
+Note, this project is under development. Things might change/break frequently and without warning.
 
 ------------
 

diff --git a/docs/development/contrib_code.rst b/docs/development/contrib_code.rst
@@ -45,6 +45,7 @@ New code releases to PyPI and conda are published automatically when a tag is pu
     $ git commit --allow-empty -m "Release $RELEASE"
     $ git tag -a $RELEASE -m "Version $RELEASE"
     $ # Build the corresponding version of the catalog (make sure this job finishes successfully before progressing)
-    $ qsub ./bin/build_all.sh
+    $ cd bin
+    $ qsub build_all.sh
     $ # Push the tag to github to trigger the code release
     $ git push --tags
diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst
@@ -37,6 +37,6 @@ The catalog is not yet available in one of the pre-built analysis environments o
    * :code:`/g/data3/hh5/public/apps/miniconda3` under "Python or Conda virtual environment base";
    * :code:`access-nri-catalog` under "Conda environment". 
 
-   | From this session, you should be able to run the example notebooks in the `notebooks directory of this repo <https://github.com/ACCESS-NRI/access-nri-intake-catalog/tree/main/notebooks>`_. Note, static renderings of these notebooks are also included in the :ref:`How-to guides <How_tos>` section of this documentation.
+   | From this session, you should be able to run the example notebooks in the `docs/how_tos directory of this repo <https://github.com/ACCESS-NRI/access-nri-intake-catalog/tree/main/docs/how_tos>`_. Note, static renderings of these notebooks are also included in the :ref:`How-to guides <How_tos>` section of this documentation.
 
 
diff --git a/docs/how_tos/building_intake-esm_catalogs.ipynb b/docs/how_tos/building_intake-esm_catalogs.ipynb
diff --git a/docs/how_tos/building_intake-esm_catalogs.ipynb b/docs/how_tos/building_intake-esm_catalogs.ipynb
diff --git a/docs/how_tos/example_usage.ipynb b/docs/how_tos/example_usage.ipynb
diff --git a/docs/how_tos/example_usage.ipynb b/docs/how_tos/example_usage.ipynb
diff --git a/docs/how_tos/index.rst b/docs/how_tos/index.rst
@@ -7,16 +7,16 @@ How-to guides
    :maxdepth: 1
    :hidden:
 
-   example_usage
-   building_intake-esm_catalogs
+   example_usage.ipynb
+   building_intake-esm_catalogs.ipynb
 
 These pages provide some how-to guides in the form of Jupyter notebooks that can be run on Gadi:
 
-* The notebook on `example catalog usage`_ demonstrates the basic functions of the ACCESS-NRI Intake catalog including searching for experiment subcatalogs, loading subcatalogs, searching for datasets in subcatalogs and loading data from subcatalogs.
-* The notebook on `building intake-esm catalogs`_ demonstrates how to build your own intake-esm catalog for data from an experiment you have just run (for example).
+* The notebook on `example usage of the ACCESS-NRI catalog`_ demonstrates the basic functions of the ACCESS-NRI Intake catalog including searching for experiment subcatalogs, loading subcatalogs, searching for datasets in subcatalogs and loading data from subcatalogs.
+* The notebook on `building your own intake-esm catalog`_ demonstrates how to build your own intake-esm catalog for data from an experiment you have just run (for example).
 
-.. _example catalog usage: example_usage.ipynb
-.. _building intake-esm catalogs: building_intake-esm_catalogs.ipynb
+.. _example usage of the ACCESS-NRI catalog: example_usage.html
+.. _building your own intake-esm catalog: building_intake-esm_catalogs.html
 
 .. note::
    If you'd like to see a new how-to, or you find any issues, please open an issue `here <https://github.com/ACCESS-NRI/access-nri-intake-catalog/issues>`_.
diff --git a/notebooks/building_intake-esm_catalogs.ipynb b/notebooks/building_intake-esm_catalogs.ipynb