Skip to content

Commit 21de04a

Browse files
committed
address PR review comments
1 parent 1184152 commit 21de04a

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

doc/source/installation.rst

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,17 +144,29 @@ Follow the steps in:
144144

145145
MDAnalysis uses different Git branches for different purposes:
146146

147-
- **package-X.Y.Z**: These branches contain specific stable releases (e.g., ``package-2.9.0``) and are intended for users who need reproducibility, debugging, or version locking. You can browse them on the GitHub `Branches page`_ or view official releases on the `Releases page`_.
148-
- **develop**: The `develop`_ branch is the default and active development branch. If you're contributing to MDAnalysis or want the latest features before they're released, base your work on this branch (see :ref:`development-installation`).
147+
- **package-X.Y.Z**: These are tags, not branches, and represent stable release versions (e.g., package-2.9.0). These tags are ideal if you need reproducibility, debugging, or version locking. You can browse all tags on the GitHub `Branches page`_.
148+
- **develop**: The `develop`_ branch is the default and active development branch. If you're contributing to MDAnalysis or want the latest unreleased features, base your work on this branch (see :ref:`development-installation`).
149149

150-
To install the **latest stable release** from source:
150+
Clone the repository and check out the tag corresponding to the desired version:
151151

152152
.. code-block:: bash
153153
154154
git clone https://github.com/MDAnalysis/mdanalysis
155155
cd mdanalysis
156-
git switch release-<latest-version>
157-
pip install .
156+
git checkout package-<version>
157+
158+
You will now be in a detached HEAD state, which is expected when checking out a tag. This allows you to explore or install that version without affecting branches.
159+
If you plan to make changes, you can create a new branch based on the tag:
160+
161+
.. code-block:: bash
162+
163+
git switch -c my-fix-based-on-2.9.0
164+
165+
To install MDAnalysis from this version:
166+
167+
.. code-block:: bash
168+
169+
pip install package/.
158170
159171
To run tests:
160172

0 commit comments

Comments
 (0)