luabida / episcanner-downloader

Episcanner Downloader

Episcanner Downloader is a data downloader for the Episcanner application. It retrieves data related to diseases like dengue and chikungunya and saves it in a specified directory.

Features

• Fetches data related to diseases from the Episcanner application
• Supports downloading data for specific diseases
• Saves downloaded data to a designated directory

Installation

To install Episcanner Downloader, follow these steps:

1. Clone the repository:

   git clone https://github.com/AlertaDengue/episcanner-downloader.git

2. Navigate to the cloned directory:

   cd episcanner-downloader

Using Conda

1. Create a Conda environment using the provided YAML file:

   conda env create -f conda/env-base.yaml

2. conda activate episcanner

   conda activate episcanner

3. Install the dependencies using Poetry:

   poetry install

Using a Virtual Environment (venv)

1. Create a virtual environment:

   python -m venv env

2. Activate the virtual environment:

   source env/bin/activate

3. Install the dependencies using Poetry:

   poetry install

Setting Environment Variables

Before running Episcanner Downloader, make sure to set the required environment variables for connecting to the PSQL database. You can use the provided Makefile to create a .env file with the exported variables:

1. Set the required environment variables for connecting to the PSQL database:

   export PSQL_USER=<your_psql_user>
   export PSQL_PASSWORD=<your_psql_password>
   export PSQL_HOST=<your_psql_host>
   export PSQL_PORT=<your_psql_port>
   export PSQL_USER=<your_psql_database>

2. Create a .env file in the project root directory with the exported variables.

   make create-dotenv

Usage

To use Episcanner Downloader, follow these steps:

1. Activate the project's virtual environment:

   source /path/to/episcanner-downloader/venv/bin/activate

2. Run the Episcanner Downloader:

   mkdir data 
   python epi_scanner/downloader/export_data.py -s <source> -d <diseases> -o data 

Replace with the desired source (e.g., 'MG', or 'all' to download all states) and with the specific diseases you want to download (e.g., 'dengue chikungunya'). Specify the <output_directory> where the data should be saved.

License

Episcanner Downloader is licensed under the MIT License. See the LICENSE file for more details.