Merge pull request #23 from microsoft/wesselb/ai-models-plugin-docs

Add information about `ai-models-aurora`
microsoft · Sep 6, 2024 · 52a1ea0 · 52a1ea0
2 parents c818005 + c473f21
commit 52a1ea0
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -8,4 +8,5 @@ chapters:
 - file: finetuning
 - file: example_era5
 - file: example_hres_t0
+- file: ai_models_plugin
 - file: api
diff --git a/docs/ai_models_plugin.md b/docs/ai_models_plugin.md
@@ -0,0 +1,18 @@
+# Plugin for ECMWF's `ai-models`
+
+Aurora is a supported model for ECMWF's
+[`ai-models`](https://github.com/ecmwf-lab/ai-models)
+through the plugin
+[`ai-models-aurora`](https://github.com/ecmwf-lab/ai-models-aurora).
+Install this plugin with `pip`:
+
+```bash
+pip install ai-models-aurora
+```
+
+See
+[the documentation of `ai-models`](https://github.com/ecmwf-lab/ai-models)
+for more information about `ai-models`
+and see
+[the documentation of `ai-models-aurora`](https://github.com/ecmwf-lab/ai-models-aurora)
+for more information about the Aurora plugin.