Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Miguel Boubeta committed Feb 23, 2023
1 parent c73a55c commit 295fbf6
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,39 @@
# chaimeleon-etl-chup_prostate
# chaimeleon-etl-chup-prostate

## Deploy notes

1. Download/copy xlsx and csv files on data folder (./data).
2. Deploy datake database running below command:
1. Clone the repository
```sh
git clone https://github.com/chaimeleon-eu/chaimeleon-etl-chup-prostate.git
```
2. Initialize the submodule
```sh
git submodule init
git submodule update
```
3. Download/copy xlsx and csv files on data folder (./data).
4. Deploy datake database running below command:
```sh
make deploy_datalake
```
3. Now, you can run ETL in two ways:
5. Now, you can run ETL in two ways:

3.1 Running the two dataflows at once:
5.1 Running the two dataflows at once:
```sh
make etl_chup_prostate
```

3.2 Or running dataflows in several process:
5.2 Or running dataflows in several process:
```sh
make etl_chup_prostate_datalake
make etl_chup_prostate_indexa
```
4. Check everything is okay querying data on indexa database and/or seeing outputs from above commands.
5. Stop and remove datalake container.
6. Check everything is okay querying data on indexa database and/or seeing outputs from above commands.
7. Stop and remove datalake container.
```sh
make down
```
6. Retrieve xml files from outputs folder.
8. Retrieve xml files from outputs folder.

## Software dependencies
* Docker (tested version: **20.10.17, build 100c701**).
Expand Down

0 comments on commit 295fbf6

Please sign in to comment.