Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
christinab12 authored Apr 30, 2024
1 parent 28865fd commit 871a493
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions src/client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,28 @@ The client of our data centric platform for microscopy imaging.

## How to use?

### Installation
This has been tested on Python versions 3.9, 3.10 and 3.11 on latest versions of Windows, Ubuntu and MacOS. In your dedicated environment run:
### Installation

For installing dcp-client you will first need to clone the repo:

```
git clone https://github.com/HelmholtzAI-Consultants-Munich/data-centric-platform.git
```

Then navigate to the client directory:
```
pip install dcp_client
cd data-centric-platform/src/client
```

### Installation for developers
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:
In your dedicated environment run:
```
pip install -e .
```

This installation has been thoroughly tested using a conda environment with python version 3.9, 3.10, 3.11 on a macOS local machine.



#### Launch DCP client
Make sure the server is already running, either locally or remotely. Then, depending on the configuration, simply run:
```
Expand Down

0 comments on commit 871a493

Please sign in to comment.