From 3d4ee3d3a194b4ad629b726c8e75604806c3b7bf Mon Sep 17 00:00:00 2001 From: Christina Bukas <31160776+christinab12@users.noreply.github.com> Date: Tue, 30 Apr 2024 12:27:44 +0200 Subject: [PATCH] Update dcp_client_installation.rst --- docs/source/dcp_client_installation.rst | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/source/dcp_client_installation.rst b/docs/source/dcp_client_installation.rst index f501733..7df4520 100644 --- a/docs/source/dcp_client_installation.rst +++ b/docs/source/dcp_client_installation.rst @@ -11,12 +11,28 @@ The client of our data centric platform for microscopy imaging. Installation ------------- -Before starting make sure you have navigated to ``data-centric-platform/src/client``. All future steps expect you are in the client directory. This installation has been tested using a conda environment with python version 3.9 on a mac local machine. In your dedicated environment run: +For installing dcp-client you will first need to clone the repo: + +.. code-block:: bash + + git clone https://github.com/HelmholtzAI-Consultants-Munich/data-centric-platform.git + + +Then navigate to the client directory: + +.. code-block:: bash + + cd data-centric-platform/src/client + +In your dedicated environment run: .. code-block:: bash pip install -e . + +This installation has been thoroughly tested using a conda environment with python version 3.9, 3.10, 3.11 and 3.12 on a macOS local machine. + Running the client: A step-by-step guide! ------------------------------------------