Skip to content

Commit 14d3af5

Browse files
committed
Update main README document
1 parent f9d4418 commit 14d3af5

1 file changed

Lines changed: 18 additions & 24 deletions

File tree

README.md

Lines changed: 18 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ Backend part of the OmicsPred Project
88
## Roles
99
Manage import, querying and retrieval of the OmicsPred metadata:
1010

11-
* Scripts to import the metadata and generate the genetic scoring files (app [imports](https://github.com/OmicsPred/omicspred_backend/tree/main/imports))
12-
* Access the databases (apps [omicspred](https://github.com/OmicsPred/omicspred_backend/tree/main/omicspred), [applications](https://github.com/OmicsPred/omicspred_backend/tree/main/applications), [plot](https://github.com/OmicsPred/omicspred_backend/tree/main/plot)) *[read & write]*
11+
* Scripts to import the metadata and generate the genetic scoring files (app [imports](https://github.com/OmicsPred/omicspred_backend/tree/main/imports) -> [README](https://github.com/OmicsPred/omicspred_backend/tree/main/imports/README.md))
12+
* Scripts to export the metadata and data (app [exports](https://github.com/OmicsPred/omicspred_backend/tree/main/exports))
13+
* Access the databases (apps [omicspred](https://github.com/OmicsPred/omicspred_backend/tree/main/omicspred), [plot](https://github.com/OmicsPred/omicspred_backend/tree/main/plot)) *[read & write]*
1314
* Provide private (accessible by the website) and public REST APIs (app [rest_api](https://github.com/OmicsPred/omicspred_backend/tree/main/rest_api)) *[read only]*
1415
* Build and query the search engine (app [search_es](https://github.com/OmicsPred/omicspred_backend/tree/main/search_es)) using ElasticSearch *[read & write]*
1516

1617
## Softwares / tools
1718

18-
1919
| Tool | Role | Version |
2020
| ---- | ---- | ------- |
21-
| [PostgreSQL](https://www.postgresql.org/)| Database to store and query metadata | >= 15 |
22-
| [ElasticSearch](https://www.elastic.co/) | Server used as search engine | 7.xx (e.g. 7.17) |
23-
| [Django ](https://www.djangoproject.com/) | Python framework to communicate with the database, the ElasticSearch indexes and build a REST API | 5.2.x (e.g. 5.2.5) |
21+
| [PostgreSQL](https://www.postgresql.org/)| Database to store and query metadata | >= 18 |
22+
| [ElasticSearch](https://www.elastic.co/) | Server used as search engine | 8.xx (e.g. 8.19) |
23+
| [Django ](https://www.djangoproject.com/) | Python framework to communicate with the database, the ElasticSearch indexes and build a REST API | 6.0.x (e.g. 6.0.7) |
2424

2525

2626
## Setup
@@ -43,27 +43,18 @@ Go to root of the repository (e.g. `cd .../omicspred_backend`)
4343

4444
* Create **ElasticSearch** indexes
4545

46-
* Main indexes
47-
48-
```bash
49-
python manage.py search_index --rebuild -f
50-
```
51-
52-
* Phenotype index
46+
```bash
47+
python manage.py search_index --create
48+
```
5349

54-
* In *search_es/indexes.py*, comment all the lines and uncomment the PhenotypeDocument line
55-
* In *applications/models.py*, replace the line `applications_db = 'applications'` by `applications_db = 'default'`
56-
* In *config/settings.py*:
57-
* Comment the `DATABASE[‘default’]` items
58-
* Rename `DATABASE[‘applications’]` by `DATABASE[‘default’]`
59-
* Run script
50+
> [!WARNING]
51+
> The indexing of the scores takes few hours (2-3h)!
6052
61-
```bash
62-
python manage.py search_index --rebuild -f
63-
```
53+
To rebuild existing OmicsPred indexes:
6454

65-
> [!WARNING]
66-
> Do not forget to revert all these changes after generating the Phenotype search index!
55+
```bash
56+
python manage.py search_index --rebuild -f
57+
```
6758

6859
* For **local** deployment, run the command:
6960

@@ -95,6 +86,9 @@ To run the tests manually, run the command:
9586
python manage.py test
9687
```
9788

89+
> [!NOTE]
90+
> This runs the REST API, exports and imports tests
91+
9892
or to only run one test (e.g. metadata imports):
9993

10094
```bash

0 commit comments

Comments
 (0)