Skip to content

Commit

Permalink
feat: add scripts to setup FLOWViZ and PhyloDB.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nyckoka committed Oct 20, 2024
1 parent 48c8c42 commit f971003
Show file tree
Hide file tree
Showing 5 changed files with 99 additions and 0 deletions.
53 changes: 53 additions & 0 deletions scripts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# FLOWViZ

## Setup

To setup FLOWViZ, the `flowviz_setup.sh` script can be used.

Run the script with the following command (inside the `scripts` directory):

```bash
./flowviz_setup.sh
```

It creates the FLOWViZ directory and clones the repository into it, and then, as the script itself tells you, it will only execute steps 1 and 2 of the manual setup that is present here: https://github.com/devandrepascoa/FLOWViZ?tab=readme-ov-file#manual-setup

**After running `flowviz_setup.sh`, you still need to execute steps 3 to 6 of the manual
setup.**

## Clean up

To clean up the setup, the `flowviz_cleanup.sh` script can be used.

Run the script with the following command (inside the `scripts` directory):

```bash
./flowviz_cleanup.sh
```

It will remove the FLOWViZ directory and all its contents, after having destroyed any running containers.

# PhyloDB

## Setup
To setup PhyloDB, the `phyloDB_setup.sh` script can be used.

Run the script with the following command (inside the `scripts` directory):

```bash
./phyloDB_setup.sh
```

It creates the PhyloDB directory and clones the repository into it, then launches the PhyloDB containers.

## Clean up

To clean up the setup, the `phyloDB_cleanup.sh` script can be used.

Run the script with the following command (inside the `scripts` directory):

```bash
./phyloDB_cleanup.sh
```

It will remove the PhyloDB directory and all its contents, after having destroyed any running containers.
9 changes: 9 additions & 0 deletions scripts/flowviz_cleanup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/bin/bash

cd ../FLOWViZ

./cleanup.sh

cd ..

rm -rf ./FLOWViZ/
18 changes: 18 additions & 0 deletions scripts/flowviz_setup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/bin/bash

cd ..

git clone https://github.com/devandrepascoa/FLOWViZ.git # https://github.com/DIVA-IPL-Project/FLOWViZ.git

cd ./FLOWViZ

echo "Steps 1 and 2 of the manual setup are going to be executed..."

./setupAirflow.sh

echo "Setting up FLOWViZ docker..."
docker compose up -d
echo "FLOWViZ docker setup completed!"

echo "Steps 1 and 2 of the manual setup were executed successfully!"
echo "Now you still need to execute steps 3 to 6 of the manual setup. (https://github.com/devandrepascoa/FLOWViZ?tab=readme-ov-file#manual-setup)"
9 changes: 9 additions & 0 deletions scripts/phylodb_cleanup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/bin/bash

cd ../phyloDB

docker compose down

cd ..

rm -rf ./phyloDB/
10 changes: 10 additions & 0 deletions scripts/phylodb_setup.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#!/bin/bash

cd ..

git clone https://github.com/devandrepascoa/phyloDB.git # https://github.com/phyloviz/phyloDB.git

cd phyloDB/

./build-docker.sh
./launch-docker.sh

0 comments on commit f971003

Please sign in to comment.