Skip to content

Commit

Permalink
Update installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverwm1 committed Nov 18, 2024
1 parent 4eb3d50 commit a648e29
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions fme/docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit a648e29

Please sign in to comment.