From db7f7a515b04cccdcde2aee5ee252335a38d6955 Mon Sep 17 00:00:00 2001 From: misi9170 <39596329+misi9170@users.noreply.github.com> Date: Tue, 13 Aug 2024 13:43:01 -0400 Subject: [PATCH] Update for PyPI installation. (#204) --- docs/installation.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 81d5dac2..086de17f 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -41,11 +41,23 @@ in an interactive environment like Jupyter. --> # Installation -FLASC is currently not available as a package on any repository manager. -Instead, it must be installed by the user by cloning the GitHub repository. +FLASC is available as a package on PyPI. We strongly recommend installing FLASC +into a conda environment. To do this, use the following commands (replacing +`flasc-env` with the conda environment name of your choosing). +```bash +# Create a conda environment containing python and activate it +conda create --name flasc-env python +conda activate flasc-env -To download the source code, use `git clone`. Then, add it to -your Python path with the "local editable install" through `pip`. +# Pip install flasc and its dependencies from PyPI +pip install flasc +``` +That's it, now you're ready to use FLASC. + +To download the source code from the GitHub repository (which will also give +you access to the examples) and install locally, +use `git clone`. Then, add it to your Python path with the "local editable install" through `pip`. Again, we recommend doing this in a dedicated conda environment +(see conda commands above). ```bash # Download the source code.