documentation

docs/apis/code/state.py

@@ -0,0 +1,47 @@
+import datetime
+
+import numpy as np
+
+from anemoi.inference.runner import DefaultRunner
+
+# Create a runner with the checkpoint file
+runner = DefaultRunner("checkpoint.ckpt")
+
+# Select a starting date
+date = datetime.datetime(2024, 10, 25)
+
+# Assuming that the initial conditions requires two
+# dates, e.g. T0 and T-6
+
+lagged = 2
+
+# Define the grid
+
+latitudes = np.linspace(90, -90, 181)  # 1 degree resolution
+longitudes = np.linspace(0, 359, 360)
+
+number_of_points = len(latitudes) * len(longitudes)
+latitudes, longitudes = np.meshgrid(latitudes, longitudes)
+
+# Create the initial state
+
+input_state = {
+    "date": date,
+    "latitudes": latitudes,
+    "longitudes": longitudes,
+    "fields": {
+        "2t": np.random.rand(lagged, number_of_points),
+        "msl": np.random.rand(lagged, number_of_points),
+        "z_500": np.random.rand(lagged, number_of_points),
+        ...: ...,
+    },
+}
+
+# Run the model
+
+for state in runner.run(input_state=input_state, lead_time=240):
+    # This is the date of the new state
+    print("New state:", state["date"])
+
+    # This is value of a field for that date
+    print("Forecasted 2t:", state["fields"]["2t"])

docs/apis/level1.rst

@@ -0,0 +1,16 @@
+.. _api_level1:
+
+####################
+ NumPy to NumPy API
+####################
+
+The simplest way to run a inference from a checkpoint is to provide the
+initial state as a dictionary containing NumPy arrays for each input
+variable.
+
+You then create a Runner object and call the `run` method, which will
+yield the state at each time step. Below is a simple code example to
+illustrate this:
+
+.. literalinclude:: code/state.py
+   :language: python

docs/apis/level2.rst

@@ -0,0 +1,5 @@
+.. _api_level2:
+
+#####################
+ Object oriented API
+#####################

docs/apis/level3.rst

@@ -0,0 +1,5 @@
+.. _api_level1:
+
+##################
+ Command line API
+##################

docs/cli/inspect.rst

@@ -0,0 +1,8 @@
+inspect
+==========
+
+.. argparse::
+    :module: anemoi.inference.__main__
+    :func: create_parser
+    :prog: anemoi-inference
+    :path: inspect

docs/cli/introduction.rst

@@ -15,7 +15,12 @@ The commands are:
 .. toctree::
     :maxdepth: 1
 
+    run
     metadata
+    inspect
+    patch
+    requests
+
 
 .. argparse::
     :module: anemoi.inference.__main__

docs/cli/patch.rst

@@ -0,0 +1,8 @@
+patch
+==========
+
+.. argparse::
+    :module: anemoi.inference.__main__
+    :func: create_parser
+    :prog: anemoi-inference
+    :path: patch

docs/cli/requests.rst

@@ -0,0 +1,8 @@
+requests
+==========
+
+.. argparse::
+    :module: anemoi.inference.__main__
+    :func: create_parser
+    :prog: anemoi-inference
+    :path: requests

docs/cli/run.rst

@@ -0,0 +1,8 @@
+run
+==========
+
+.. argparse::
+    :module: anemoi.inference.__main__
+    :func: create_parser
+    :prog: anemoi-inference
+    :path: run

docs/index.rst

@@ -30,6 +30,21 @@ of the *Anemoi* packages.
 
    installing
 
+**Tree levels of APIs**
+
+-  :doc:`apis/level1`
+-  :doc:`apis/level2`
+-  :doc:`apis/level3`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+   :caption: APIs
+
+   apis/level1
+   apis/level2
+   apis/level3
+
 *********
  Modules
 *********

docs/modules/checkpoint.rst

@@ -0,0 +1,8 @@
+############
+ checkpoint
+############
+
+.. automodule:: anemoi.inference.checkpoint
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/modules/forcings.rst

@@ -0,0 +1,8 @@
+##########
+ forcings
+##########
+
+.. automodule:: anemoi.inference.forcings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/modules/input.rst

@@ -0,0 +1,8 @@
+#######
+ input
+#######
+
+.. automodule:: anemoi.inference.input
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/modules/metadata.rst

@@ -0,0 +1,8 @@
+##########
+ metadata
+##########
+
+.. automodule:: anemoi.inference.metadata
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/modules/output.rst

@@ -0,0 +1,8 @@
+########
+ output
+########
+
+.. automodule:: anemoi.inference.output
+   :members:
+   :no-undoc-members:
+   :show-inheritance: