Skip to content

Commit 165811f

Browse files
committed
Update Python version and refine README formatting
Updated conda environment setup to use Python 3.11 instead of 3.10. Simplified and clarified README instructions, improving formatting and ensuring consistent language throughout.
1 parent 00d15ef commit 165811f

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

+11-13
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ The `plantdb` packages are available through:
7373

7474
To create a new conda environment for PlantDB:
7575
``` shell
76-
conda create -n plantdb 'python=3.10' ipython
76+
conda create -n plantdb 'python=3.11' ipython
7777
```
7878

7979
## Installation
@@ -96,16 +96,14 @@ conda install -c romi-eu plantdb plantdb.server plantdb.client
9696

9797
### For Developers
9898

99-
To install the library for development:
100-
101-
1. Clone the repository:
102-
``` shell
103-
git clone https://github.com/romi/plantdb.git -b dev # clone the 'dev' branch
104-
cd plantdb
105-
conda activate plantdb # activate your environment first!
106-
```
99+
To install the library for development, you first have to clone the repository:
100+
``` shell
101+
git clone https://github.com/romi/plantdb.git -b dev # clone the 'dev' branch
102+
cd plantdb
103+
conda activate plantdb # activate your environment first!
104+
```
107105

108-
2. Install components:
106+
Then you may proceed to install the following components:
109107
#### Core library:
110108
``` shell
111109
python -m pip install -e src/commons/.
@@ -179,7 +177,7 @@ If you want to use it, simply do:
179177
docker run -p 5000:5000 -v $ROMI_DB:/myapp/db -it roboticsmicrofarms/plantdb
180178
```
181179

182-
**Obviously you have to install docker first!**
180+
**Obviously, you have to install docker first!**
183181

184182
## Usage
185183

@@ -203,7 +201,7 @@ dataset = db.get_scan("real_plant")
203201
img_fs = dataset.get_fileset('images')
204202
```
205203

206-
A detailed documentation of the Python API is available here: https://romi.github.io/plantdb/reference.html
204+
Detailed documentation of the Python API is available here: https://romi.github.io/plantdb/reference.html
207205

208206
### Serve the REST API
209207

@@ -230,7 +228,7 @@ Open your favorite browser here:
230228
- scans: http://0.0.0.0:5000/scans
231229
- 'real_plant_analyzed' dataset: http://0.0.0.0:5000/scans/real_plant_analyzed
232230

233-
A detailed documentation of the REST API is available here: https://romi.github.io/plantdb/webapi.html
231+
Detailed documentation of the REST API is available here: https://romi.github.io/plantdb/webapi.html
234232

235233
## Developers & contributors
236234

0 commit comments

Comments
 (0)