Skip to content

Commit 487b738

Browse files
authored
Update index.rst
changes recommended install directions to point to master as devel is meant to be an unstable development branch, not the place where the latest codebase lives
1 parent 71135e9 commit 487b738

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/index.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,10 @@ Installation
3636

3737
To install SeisFlows and its dependencies, we recommend installing within
3838
a Conda environment to not affect your root environment. The
39-
`devel <https://github.com/adjtomo/seisflows/tree/devel>`__ branch
40-
houses the most up-to-date codebase.
39+
`master <https://github.com/adjtomo/seisflows/>`__ branch contains the most
40+
stable release and is the preferred installation branch. The
41+
`devel <https://github.com/adjtomo/seisflows/tree/devel>`__ branch houses
42+
the most up-to-date codebase, but is likely to be **unstable**.
4143

4244
.. note::
4345

@@ -47,7 +49,7 @@ houses the most up-to-date codebase.
4749

4850
.. code:: bash
4951
50-
git clone --branch devel https://github.com/adjtomo/seisflows.git
52+
git clone https://github.com/adjtomo/seisflows.git
5153
cd seisflows
5254
conda env create -f environment.yml
5355
conda activate seisflows
@@ -61,7 +63,7 @@ SeisFlows and it's dependencies there, you can run the following:
6163

6264
.. code:: bash
6365
64-
git clone --branch devel https://github.com/adjtomo/seisflows.git
66+
git clone https://github.com/adjtomo/seisflows.git
6567
cd seisflows
6668
conda activate <your environment>
6769
conda env update --name <your environment> --file environment.yml

0 commit comments

Comments
 (0)