Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs on environments #109

Merged
merged 3 commits into from
Jul 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/datastores/builders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ set of Intake-ESM datastore Builders for different ACCESS model outputs. In gene
datastore for your ACCESS model output should be as simple as passing your output base directory to an
appropriate Builder.

The access-nri-intake package is installed in the :code:`xp65` and :code:`hh5` analysis environments, or
The access-nri-intake package is installed in the :code:`hh5` and :code:`xp65` analysis environments, or
users can install it into their own environment (see :ref:`installation` for details). The Builders can be
imported from the :code:`access_nri_intake.source.builders` submodule.

Expand Down
1 change: 1 addition & 0 deletions docs/project_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
* :code:`oi10`
* :code:`p73`
* :code:`rr3`
* :code:`xp65`
2 changes: 1 addition & 1 deletion docs/storage_flags.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
.. code-block::

gdata/al33+gdata/cj50+gdata/dk92+gdata/fs38+gdata/ik11+gdata/oi10+gdata/p73+gdata/rr3
gdata/al33+gdata/cj50+gdata/dk92+gdata/fs38+gdata/ik11+gdata/oi10+gdata/p73+gdata/rr3+gdata/xp65
39 changes: 21 additions & 18 deletions docs/usage/how.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,34 +19,38 @@ In order to use the catalog, you will need to have the following:
Note you will need to join a project with a compute allocation. If you don't know what project is
appropriate you will need to seek help from your local group or IT support.

#. **Access to the** :code:`xp65` **project**: this project houses the catalog table files. See the
`NCI documentation for how to join projects <https://opus.nci.org.au/display/Help/How+to+connect+to+a+project>`_.

#. **Access to the projects that house the data you're interested in**: the catalog references data
products across multiple projects on Gadi. Currently, data is included from the following projects:

.. include:: ../project_list.rst

If you wish to be able to access all the data in the catalog, you will need to be a member of all
these projects. See the `NCI documentation for how to join projects
<https://opus.nci.org.au/display/Help/How+to+connect+to+a+project>`_.
these projects.

.. attention::

Catalog users will only be able to load data from projects that they have access to.

#. **Access to the** :code:`xp65` **or** :code:`hh5` **projects**: these projects provide public
analysis environments in which the ACCESS-NRI catalog is installed (along with many other useful
packages). Alternatively, you can install the catalog into your own environment.
#. **An installation of the catalog**: the catalog is pre-installed in the
`CLEX CMS "analysis3" conda environment <http://climate-cms.wikis.unsw.edu.au/Conda>`_ (>=23.04) and
the ACCESS-NRI "access-med" conda environment (all versions). Users are encouraged to use one of these
environments to use the catalog. Alternatively, you can install the catalog into your own environment
as described below.

.. warning::
The ACCESS-NRI catalog is actually not yet installed in the :code:`hh5` environments, so for now
you'll have to use the :code:`xp65` environment.
.. attention::
In order to use the CLEX CMS conda environments, you will need to also be a member of the
:code:`hh5` project

.. _installation:

Installing the catalog
^^^^^^^^^^^^^^^^^^^^^^

Most users will not need to install the catalog themselves and will instead use the catalog through one
of the public analysis environments provided in either :code:`xp65` or :code:`hh5` (see below).
of the public analysis environments provided in either :code:`hh5` or :code:`xp65` (see below).

Advanced users that want to install the catalog into their own environment can do so in three ways:

Expand Down Expand Up @@ -86,22 +90,21 @@ data it references are available from your session. In particular:

* **Setting the storage flags**: in addition to being a member of the projects you want to access, you
also have to explicity tell the JupyterLab app that you want to access them in your session. Specify
the project storage paths by entering them in the “Storage” dropdown. To allow access to all data
products in the catalog enter:
the project storage paths by entering them in the “Storage” dropdown. To allow access to the catalog
and all the data products it contains enter:

.. include:: ../storage_flags.rst

If you want to use the :code:`xp65` or :code:`hh5` analysis environment, you'll also need to add
:code:`gdata/xp65` or :code:`gdata/hh5`, respectively.
If you want to use the :code:`hh5` analysis environment, you'll also need to add :code:`gdata/hh5`.

.. attention::
You need to be a member of all projects you enter here. You can see what projects you are part of
at `https://my.nci.org.au/mancini <https://my.nci.org.au/mancini>`_.

* **Setting the environment**: you need to make sure that the catalog is installed in your JupyterLab
session. As mentioned above, the easiest way to do this is to use either the :code:`xp65` or
:code:`hh5` public analysis environments. You can activate the :code:`xp65` environment within your
session. As mentioned above, the easiest way to do this is to use either the :code:`hh5` or
:code:`xp65` public analysis environments. You can activate the :code:`hh5` environment within your
JupyterLab session using the "Advanced options" to set the "Module directories" to
:code:`/g/data/xp65/public/modules` and "Modules" to :code:`conda/are`. Similarly, to use the
:code:`hh5` environment, set "Module directories" to :code:`/g/data/hh5/public/modules` and "Modules"
to :code:`conda/analysis3`.
:code:`/g/data/hh5/public/modules` and "Modules" to :code:`conda/analysis3-unstable`. Similarly, to use
the :code:`xp65` environment, set "Module directories" to :code:`/g/data/xp65/public/modules` and
"Modules" to :code:`conda/are`.
6 changes: 3 additions & 3 deletions docs/usage/quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1776,7 +1776,7 @@
"id": "d292b4d3-e72b-48e7-92b8-7bb8994012c1",
"metadata": {},
"source": [
"Now that we have our data, we can do our \"analysis\", which here is to simply plot the timeseries."
"Now that we have our datasets, we can do our \"analysis\", which here is to simply plot the timeseries. Note that at this point, we still haven't actually loaded any product data into memory. Our datasets are [dask-backed xarray Dataset objects](https://docs.xarray.dev/en/stable/user-guide/dask.html#parallel-computing-with-dask) that will only be evaluated when required (or computed explicitly), for example when we try to plot our data:"
]
},
{
Expand Down Expand Up @@ -4280,9 +4280,9 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python (access-nri-intake-test)",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "access-nri-intake-test"
"name": "python3"
},
"language_info": {
"codemirror_mode": {
Expand Down
1 change: 1 addition & 0 deletions src/access_nri_intake/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ def _get_project(path):
project |= set(esm_ds.df["path"].map(_get_project))

project |= {_get_project(path) for path in args["path"]}
project |= {_get_project(build_base_path)}
storage_flags = "+".join(sorted([f"gdata/{proj}" for proj in project]))

# Build the catalog
Expand Down
2 changes: 1 addition & 1 deletion src/access_nri_intake/data/catalog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sources:
description: ACCESS-NRI intake catalog
driver: intake_dataframe_catalog.core.DfFileCatalog
metadata:
storage: gdata/al33+gdata/cj50+gdata/dk92+gdata/fs38+gdata/ik11+gdata/oi10+gdata/p73+gdata/rr3
storage: gdata/al33+gdata/cj50+gdata/dk92+gdata/fs38+gdata/ik11+gdata/oi10+gdata/p73+gdata/rr3+gdata/xp65
version: '{{version}}'
parameters:
version:
Expand Down
Loading