From a6b28f584b0f3538010c8120833a6f82b52b9112 Mon Sep 17 00:00:00 2001 From: Wessel Bruinsma Date: Wed, 18 Sep 2024 09:58:58 +0200 Subject: [PATCH] Update docs about `ai-models-aurora` --- docs/ai_models_plugin.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/ai_models_plugin.md b/docs/ai_models_plugin.md index e8bf1cd..93dd8ac 100644 --- a/docs/ai_models_plugin.md +++ b/docs/ai_models_plugin.md @@ -1,18 +1,21 @@ # Plugin for ECMWF's `ai-models` +```{warning} +The plugin was intended to be released on PyPI under the name `ai-models-aurora`. +Unfortunately, this name has been registered by a third party. +Therefore, do _not_ install the plugin from the PyPI package name `ai-model-aurora`, but instead +keep a close eye on the +[the homepage of the plugin](https://github.com/ecmwf-lab/ai-models-aurora). +``` + 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 -``` +through +[a plugin](https://github.com/ecmwf-lab/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) +[the documentation of the plugin](https://github.com/ecmwf-lab/ai-models-aurora) for more information about the Aurora plugin.