Skip to content

Commit 7d95038

Browse files
committed
Add development install instructions to the docs
1 parent 1b5edef commit 7d95038

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/index.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,20 @@ In order to make use of all features of FElupe 💎💰💍👑💎, it is sugge
7878
* `pyvista <https://github.com/pyvista/pyvista>`_ for interactive visualizations
7979
* `tqdm <https://github.com/tqdm/tqdm>`_ for showing progress bars during job evaluations
8080

81+
The development version may contain not yet released bug fixes and features. Consider using the ``--user`` option to install the package into your home directory (see `pip documentation <https://pip.pypa.io/en/stable/user_guide/#user-installs>`_ for more details). To install FElupe from the latest development branch, use
82+
83+
.. code-block:: shell
84+
85+
pip install git+https://github.com/adtzlr/felupe.git@main
86+
87+
or clone the repository and install the package in editable mode.
88+
89+
.. code-block:: shell
90+
91+
git clone https://github.com/adtzlr/felupe.git
92+
cd felupe
93+
pip install --editable .
94+
8195
Extension Packages
8296
------------------
8397

0 commit comments

Comments
 (0)