Skip to content

Commit

Permalink
minor update install procedure (#150)
Browse files Browse the repository at this point in the history
* adding legacy setup.py file for older packaging standards

* doc update alternative install instructions for existing conda environments
  • Loading branch information
bch0w authored Jan 30, 2023
1 parent 853502d commit 8084f82
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
17 changes: 16 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ Installation
~~~~~~~~~~~~

To install SeisFlows and its dependencies, we recommend installing within
a Conda environment to not affect your root environment. The `devel` branch
a Conda environment to not affect your root environment. The
`devel <https://github.com/adjtomo/seisflows/tree/devel>`__ branch
houses the most up-to-date codebase.

.. note::
Expand All @@ -51,6 +52,20 @@ houses the most up-to-date codebase.
conda env create -f environment.yml
conda activate seisflows
Alternative: update an existing environment
```````````````````````````````````````````

The above installation instructions create a **new** Conda environment named
`seisflows`. If you have an *existing* Conda environment and want to install
SeisFlows and it's dependencies there, you can run the following:

.. code:: bash
git clone --branch devel https://github.com/adjtomo/seisflows.git
cd seisflows
conda activate <your environment>
conda env update -f environment.yml --prune
---------------------------------


Expand Down
3 changes: 3 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from setuptools import setup

setup()

0 comments on commit 8084f82

Please sign in to comment.