FourCastNeXt model packaging

README.md

@@ -2,9 +2,9 @@
 
 PyEarthTools is a Python framework, containing modules for loading data; pre-processing, normalising and standardising data; defining machine learning (ML) models; training ML models; performing inference with ML models; and evaluating ML models. It contains specialised support for weather and climate data sources and models. It has an emphasis on reproducibility, shareable pipelines, and human-readable low-code pipeline definition.
 
-Source Code: [github.com/ACCESS-Community-Hub/PyEarthTools](https://github.com/ACCESS-Community-Hub/PyEarthTools)  
-Documentation: [pyearthtools.readthedocs.io](https://pyearthtools.readthedocs.io)  
-Tutorial Gallery: [available here](https://pyearthtools.readthedocs.io/en/latest/notebooks/Gallery.html)  
+Source Code: [github.com/ACCESS-Community-Hub/PyEarthTools](https://github.com/ACCESS-Community-Hub/PyEarthTools)
+Documentation: [pyearthtools.readthedocs.io](https://pyearthtools.readthedocs.io)
+Tutorial Gallery: [available here](https://pyearthtools.readthedocs.io/en/latest/notebooks/Gallery.html)
 
 
 > [!NOTE]

docs/data/data_api.md

@@ -79,9 +79,9 @@
     :members:
 
 .. autoclass:: pyearthtools.data.indexes.IntakeIndex
-    :members:                                
+    :members:
 
 .. autoclass:: pyearthtools.data.indexes.IntakeIndexCache
-    :members:                                
+    :members:
 
-```
+```

docs/data/data_index.md

@@ -11,7 +11,7 @@ The use of the data package within PyEarthTools includes:
   - Loading that data into memory for efficient use in machine learning
   - Performing scientific operations on that data as part of data pre-processing
 
-These tasks are aided by the API presented by the data package. Users looking for "how-to guides" or worked examples should review the [Tutorial Gallery](https://pyearthtools.readthedocs.io/en/latest/notebooks/Gallery.html). 
+These tasks are aided by the API presented by the data package. Users looking for "how-to guides" or worked examples should review the [Tutorial Gallery](https://pyearthtools.readthedocs.io/en/latest/notebooks/Gallery.html).
 
 The rest of this page contains reference information for the components of the Data package. The entire data API docs can be viewed at [Data API](data_api.md)
 
@@ -38,6 +38,3 @@ The rest of this page contains reference information for the components of the D
 |                  |                                               | - [CachingForecastIndex](data_api.md#pyearthtools.data.indexes.CachingForecastIndex) |
 |                  |                                               | - [IntakeIndex](data_api.md#pyearthtools.data.indexes.IntakeIndex) |
 |                  |                                               | - [IntakeIndexCache](data_api.md#pyearthtools.data.indexes.IntakeIndexCache) |
-
-
-

docs/index.md

@@ -7,9 +7,9 @@
 
 PyEarthTools is a Python framework, containing modules for loading data; pre-processing, normalising and standardising data; defining machine learning (ML) models; training ML models; performing inference with ML models; and evaluating ML models. It contains specialised support for weather and climate data sources and models. It has an emphasis on reproducibility, shareable pipelines, and human-readable low-code pipeline definition.
 
-Source Code: [github.com/ACCESS-Community-Hub/PyEarthTools](https://github.com/ACCESS-Community-Hub/PyEarthTools)  
-Documentation: [pyearthtools.readthedocs.io](https://pyearthtools.readthedocs.io)  
-Tutorial Gallery: [available here](https://pyearthtools.readthedocs.io/en/latest/notebooks/Gallery.html)  
+Source Code: [github.com/ACCESS-Community-Hub/PyEarthTools](https://github.com/ACCESS-Community-Hub/PyEarthTools)
+Documentation: [pyearthtools.readthedocs.io](https://pyearthtools.readthedocs.io)
+Tutorial Gallery: [available here](https://pyearthtools.readthedocs.io/en/latest/notebooks/Gallery.html)
 
 
 > [!NOTE]

notebooks/Gallery.ipynb

@@ -10,12 +10,26 @@
     "(Please note - many of these tutorials are being migrated from a previous code version. They are being re-tested and should be corrected in the coming days). Each tutorial will be marked with its last-tested date to make it clear what state the notebooks are in. Testing is done at NCI with a data archive already established. Some notebooks also draw data from cloud hosted data sources. A subsequent update effort will make it clearer which notebooks rely on an on-disk catalogue and which ones run from cloud sources."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "7b089a07-cb3a-4edb-9bd4-3ffdc60b2d86",
+   "metadata": {},
+   "source": [
+    "## Demonstrations\n",
+    "\n",
+    "These notebooks demonstrate some useful things that can be done with little setup effort, highlighting major capabilities and giving an illustration of the main functionality of the package.\n",
+    "\n",
+    "- [Make a weather prediction with FourCastNeXt](./demo/FourCastNeXt_Inference.ipynb)  (working as at 7/5/2025)\n"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "e3fa9f72-2f10-4200-963c-2cf06e9e6487",
    "metadata": {},
    "source": [
-    "## PyEarthTools - Tutorial Examples"
+    "## PyEarthTools - Tutorial Examples\n",
+    "\n",
+    "These notebooks start with the basics and work up towards more complex examples, showing how to work with the classes and functions within the package to achieve objectives."
    ]
   },
   {
@@ -37,7 +51,9 @@
    "id": "34ae92a9-a5d7-4465-945b-092228ad358f",
    "metadata": {},
    "source": [
-    "## PyEarthTools - Data Module"
+    "## PyEarthTools - Data Module\n",
+    "\n",
+    "These notebooks demonstrate how to work with some of the specific functionality within the data module that users may wish to know about"
    ]
   },
   {
@@ -61,7 +77,9 @@
    "id": "2a1824da-0fb6-4e9b-8382-957cf26effe2",
    "metadata": {},
    "source": [
-    "## PyEarthTools - Pipeline Module"
+    "## PyEarthTools - Pipeline Module\n",
+    "\n",
+    "These notebooks demonstrate the concepts included in the `pipeline` modules, which users may need to construct more complex data processing logic for multi-modal models."
    ]
   },
   {
@@ -100,7 +118,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.9"
+   "version": "3.11.7"
   }
  },
  "nbformat": 4,