README-uk.md

Візуалізатор вихідних даних з SaveEcoBot. Обчислює AQI

Read in English 🗺️

Це програмне забезпечення підготує та запустить панель з усіма показниками з CSV-файлу а також обчислить і покаже AQI для PM2.5 та PM10.

Розрахунки Індексу Якості Повітря (Air Quality Index) базуються на основі цього документа.

Більше скріншотів та прикладів використання наведено тут [en].

---

МЕНЮ

• Необхідне програмне забезпечення
• Використання
  • Швидкий старт
  • Повсякденне використання
    • Запуск
    • Зупинка
  • Датчики
    • Оброблення нових даних
    • Додавання нових даних
    • Видалення даних
  • Повне очищення
• Для контриб'юторів
• Плани на майбутнє
• Хочете допомоги?
• Ліцензія та авторські права

---

Необхідне програмне забезпечення

• Docker
• docker-compose (для Linux)

Використання

Швидкий старт

1. Зклонуйте цей репозиторій

git clone [email protected]:MaxymVlasov/eco-data-visualizer.git

або завантажте його як zip архів і розпакуйте.

2. Виберіть станцію SaveEcoBot на цій мапі та натисніть "Детальна інформація про станцію"
   

3. Унизу ви побачите "Завантажити дані у форматі CSV"
   
   натисніть на посилання і збережіть CSV-файл у ./data/original_data/ всередині завантаженого репозиторію.

4. Відкрийте термінал у корені eco-data-visualizer і виконайте:

# Підготовка даних
docker build -t data-transformer ./data-transformer-app
docker run -v "$PWD"/data/:/app/data/ --rm data-transformer
# Запуск візуалізації
docker-compose up -d
# Додавання даних датчиків до InfluxDB
docker build -t add_influx_data ./provisioning/influx
docker run -v "$PWD"/data/influx/:/influx-data/ --rm --network=eco-data-visualizer_default add_influx_data

<sup>Залежно від пропускної здатності вашого інтернет-каналу, параметрів процесора, жорсткого диску, розміру CSV-файлу та кількості оброблених файлів Швидкий старт може тривати різний час.
Наприклад, у ноутбуці з пропускною здатністю 100 Мбіт/с, Intel Core i7-8550U (максимальна тактова частота 4ГГц), з SSD-диском та:
- 2-ма файлами CSV (разом: 620MB) потрібно 11m47s (з них 9m39s для перетворення даних)
- 1-ним файлом CSV (513MB) - 6m16s (з них 4m18s для перетворення даних)
- 1-ним файлом CSV (107MB) - 6m35s (з них 4m32s для перетворення даних)</sup>

5. Відкрийте http://localhost/, щоб побачити візуалізацію!

Повсякденне використання

Запуск

Для запуску візуалізації відкрийте термінал у корені репозиторія і виконайте:

docker-compose up -d

Потім відкрийте http://localhost/, щоб побачити візуалізацію.

Зупинка

Для зупинки візуалізації відкрийте термінал у корені репозиторія і запустіть:

docker-compose stop

Датчики

Оброблення нових даних

1. Завантажте CSV-файл з SaveEcoBot
2. Перемістіть його в теку data/original_data цього репозиторія.
3. Виконайте:

# Видалення тимчасових файлів
docker run -v "$PWD"/data/:/app/ --rm amancevice/pandas:1.0.3-alpine sh -c "rm -f /app/csv/*.csv /app/influx/*.influx"
# Підготовка даних
docker build -t data-transformer ./data-transformer-app
docker run -v "$PWD"/data/:/app/data/ --rm data-transformer

Додавання нових даних

Для додавання нових даних у візуалізацію відкрийте термінал у корені репозиторія і виконайте:

# Запуск візуалізації
docker-compose up -d
# Додання нових даних
docker build -t add_influx_data ./provisioning/influx
docker run -v "$PWD"/data/influx/:/influx-data/ --rm --network=eco-data-visualizer_default add_influx_data

Видалення даних

Для видалення даних датчиків з візуалізації відкрийте термінал у корені репозиторія і виконайте:

docker-compose down
docker volume rm eco-data-visualizer_sensors-data

Повне очищення

Для повного очищення відкрийте термінал у корені репозиторія і запустіть:

# Зупинка візуалізації
docker-compose down
# Видалення томів з налаштуваннями та даними датчиків
docker volume rm eco-data-visualizer_grafana-settings eco-data-visualizer_sensors-data
# Видалення тимчасових файлів
docker run -v "$PWD"/data/:/app/ --rm amancevice/pandas:1.0.3-alpine sh -c "rm -f /app/csv/*.csv /app/influx/*.influx"

Для контриб'юторів

Скористайтеся тими ж інструкціями з розділу Швидкий старт, але на кроці 4 додайте --build-arg ENV=dev для data-transformer-app.

docker build --build-arg ENV=dev -t data-transformer ./data-transformer-app

Плани на майбутнє

Дивіться відповідну секцію в англомовній версії.

Хочете допомоги?

Ви можете:

• Удосконалити це програмне забезпечення (див. розділ Плани на майбутнє [en]).
• Зробити пожертву у SaveEcoBot.
• Зібрати або придбати станцію контролю якості повітря та додати її до SaveEcoBot. SaveDnipro може зібрати і додати його для вас. Замовляти тут.

Ліцензія та авторські права

Це програмне забезпечення розповсюджується під ліцензією Apache License 2.0.

Усі дані з SaveEcoBot розповсюджуються під ліцензією Creative Commons Attribution License 4.0 International.

Інші дані та джерела можуть мати інші ліцензії.

Також, використовуючи код, наданий у цьому репозиторії, ви погоджуєтеся з наступним:

• Росія незаконно анексувала Крим у 2014 році і почала війну на Донбасі, а потім і повномасштабне вторгнення в Україну 2022 року.
• Росія принесла смуток і спустошення мільйонам українців, вбила сотні невинних людей, пошкодила тисячі будівель і змусила кілька мільйонів людей стати вимушеними переселенцями.
• Путін — хуйло!