From a648e2986e7c86431345b3586ba92e2c4a762c55 Mon Sep 17 00:00:00 2001 From: Oliver Watt-Meyer Date: Mon, 18 Nov 2024 15:08:10 -0800 Subject: [PATCH] Update installation docs --- fme/docs/installation.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/fme/docs/installation.rst b/fme/docs/installation.rst index b4af960..eb5b27e 100644 --- a/fme/docs/installation.rst +++ b/fme/docs/installation.rst @@ -6,21 +6,23 @@ Installation All commands here are run from the top-level directory of the repository, unless otherwise stated. -Experimental release --------------------- +This is unsupported, pre-alpha software: use at your own risk! We are actively developing this software +and will be making breaking changes to the API. -There is no stable release. This is unsupported, pre-alpha software: use at your own risk! +PyPI +---- -To install directly from github, you can run: +To install the latest release directly from PyPI, use: .. code-block:: shell - pip install git+https://github.com/ai2cm/ace#subdirectory=fme + pip install fme Conda ----- -To install with Conda, you must retrieve the sources from github: +For convenience, we provide an easy way to create a conda environment with `fme` installed. +First, clone the repository: .. code-block:: shell @@ -41,7 +43,7 @@ This will create an environment named ``fme``, and should use the same package v Development ----------- -The package is not yet available on PyPI. Before installing, you must retrieve the sources from github: +To install directly from source for development, clone the repository: .. code-block:: shell