Skip to content

Commit

Permalink
Update docs about ai-models-aurora
Browse files Browse the repository at this point in the history
  • Loading branch information
wesselb committed Sep 18, 2024
1 parent c326fda commit a6b28f5
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions docs/ai_models_plugin.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit a6b28f5

Please sign in to comment.