Skip to content

Commit

Permalink
docs: update dev install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tomjholland committed Jan 3, 2025
1 parent a1a76d2 commit f3740bf
Showing 1 changed file with 4 additions and 29 deletions.
33 changes: 4 additions & 29 deletions docs/source/developer_guide/developer_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ virtual environment:

.. code-block:: bash
uv sync --all-extras --all-groups
uv sync --all-extras
The virtual environment is stored in the :code:`PyProBE/.venv` directory inside your and
can be activated with :code:`source .venv/bin/activate`.
Expand All @@ -58,38 +58,13 @@ This will create a kernel that you can select within VSCode in the usual way.
this method results in dependency conflicts:

1. Create and activate a virtual environment.

.. tabs::
.. tab:: venv

In your working directory:

.. code-block:: bash
python -m venv venv
source .venv/bin/activate
.. tab:: conda

In any directory:

.. code-block:: bash
conda create -n pyprobe python=3.12
conda activate pyprobe
2. Install the developer dependencies:

.. code-block:: bash
cd /path/to/your/directory/PyProBE
pip install -r requirements-dev.txt
3. Install PyProBE as a package into your virtual environment:
2. Install PyProBE as a package into your virtual environment with the developer
dependencies:

.. code-block:: bash
pip install -e .
pip install -e '.[dev, docs]'
The :code:`-e` flag installs in "editable" mode, which means changes that you
make to the code will be automatically reflected in the package inside your
Expand Down

0 comments on commit f3740bf

Please sign in to comment.