Skip to content

Commit 6980d1d

Browse files
authored
Update README.md
1 parent 0812a7a commit 6980d1d

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The core of the package is ethoscope_metadata_db which takes care of
99
A typical use case is to recover all the ethoscope dbs associated to a certain metadata file so that the user can collate them and upload them to a public dataset repository, such as Zenodo.
1010

1111
For instance:
12-
''''
12+
```
1313
from ethoscope_metadata_db import db_organiser, metadata_handler
1414
1515
metadata_filename = 'all_metadata.csv'
@@ -34,7 +34,19 @@ meta.export('Joyce_2024_only_dbs.txt')
3434
3535
#Saves all the info for our convenience
3636
meta.export('Joyce_2024_only_dbs.txt', verbose=True)
37-
''''
37+
```
3838

39-
The other class is the metadata_db_server which runs a web based UI
40-
Instructions on to set it up and run it can be found here: https://www.notion.so/giorgiogilestro/The-Metadata-Database-Server-cafac3d16ca04c0b8d4364e7624d7151
39+
The second class is the **metadata_db_server** which runs a web based UI
40+
Instructions on to set it up and run it can be found [here](https://www.notion.so/giorgiogilestro/The-Metadata-Database-Server-cafac3d16ca04c0b8d4364e7624d7151).
41+
42+
## Installation
43+
Install with pip
44+
45+
```
46+
#optional pyenv
47+
python -m venv ~/python-envs/ethoscope_db/
48+
source ~/python-envs/ethoscope_db/bin/activate
49+
50+
#install in edit mode
51+
pip install -e .
52+
```

0 commit comments

Comments
 (0)