https://github.com/cricksmaidiene/alivio
🛖 Building classification for natural disaster relief efforts
https://github.com/cricksmaidiene/alivio
geospatial-analysis python segmentation
Last synced: 2 months ago
JSON representation
🛖 Building classification for natural disaster relief efforts
- Host: GitHub
- URL: https://github.com/cricksmaidiene/alivio
- Owner: cricksmaidiene
- License: mit
- Created: 2024-01-29T05:14:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-12T07:06:53.000Z (about 1 year ago)
- Last Synced: 2025-02-10T08:24:51.389Z (4 months ago)
- Topics: geospatial-analysis, python, segmentation
- Language: Jupyter Notebook
- Homepage:
- Size: 129 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Alivio 🛖
> Building classification for natural disaster relief efforts
- [Alivio 🛖](#alivio-)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Software](#software)
- [Access Keys](#access-keys)
- [Environment Setup](#environment-setup)
- [Download \& Installation](#download--installation)
- [Scripts](#scripts)
- [Data Download Util](#data-download-util)
- [Directory Structure](#directory-structure)
## Setup
### Prerequisites
#### Software
The following software should be pre-installed on the system using this repository:
- [`conda`](https://docs.anaconda.com/anaconda/install/index.html) or a virtual environment
- [`git`](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) for version control
#### Access Keys
Create the following keys if you don't have them
- [GitHub Developer Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) - to push and pull code to and from GitHub. This should be saved to the terminal or command line.
- [AWS IAM Credentials](https://k21academy.com/amazon-web-services/create-access-and-secret-keys-in-aws/) - to access AWS resources remotely.
- Access Key
- Secret Access Key
### Environment Setup
The following commands need to be run only once, during the initial setup process.
- Create a conda environment
- Create the environment (name `alivio` is optional and name can be used)
```bash
conda create --name alivio python=3.10 -y
```
- Activate the environment
```bash
conda activate alivio
```
- Create a Jupyter Notebook Kernel
```bash
conda install -c anaconda ipykernel -y
python -m ipykernel install --user --name=alivio
```
- Install poetry for python dependency management
```bash
pip install poetry
```
- Configure AWS Credentials. This command will open up a terminal-based prompt with 4 inputs.
```bash
pip install awscli
aws configure
```
- Access Key: Your AWS Access Key
- Secret Access Key: Your AWS secret access key
- region: `us-east-1`
- format: `json`
### Download & Installation
The following commands need to be run only once, during the initial setup process.
- Clone the GitHub repository
```bash
git clone https://github.com/cricksmaidiene/alivio
```
- Visit the repository locally
```bash
cd alivio
```
- Install the python dependencies (make sure the `alivio` conda environment is active)
```bash
poetry install --no-root
```
You can now start executing notebooks and code within this virtual environment.
## Scripts
#### Data Download Util
This utility downloads relevant dataset used by the project into the `/data` directory
Additionally install the below package
```bash
pip install chardet
```
Run the below command
```bash
python src/utils/sync_data.py
```
## Directory Structure
- `/src`: for all source code and notebook files
- `src/01_data_ingestion`: For notebooks and source related to ingesting raw data
- `src/02_data_analysis`: For EDA, visualization and other analysis tasks
- `src/03_data_engineering`: For preprocessing the dataset or performing feature engineering
- `src/04_models`: For model training, fine-tuning and experimentation
- `/data`: For all data extracts saved locally
- `/docs`: For internal team documentation
- `/app`: For the web-interface