Skip to content

Commit 317f275

Browse files
MaxymVlasovMaxymVlasov
committed
Localize README and improve docs
1 parent 987ece2 commit 317f275

File tree

6 files changed

+246
-20
lines changed

6 files changed

+246
-20
lines changed

‎.vscode/extensions.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
"bierner.markdown-preview-github-styles",
2525
"yzhang.markdown-all-in-one",
2626
"DavidAnson.vscode-markdownlint",
27+
"funkyremi.vscode-google-translate",
28+
"bierner.markdown-emoji",
2729

2830
// Python
2931
"ms-python.python"

‎.vscode/settings.json‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
"ol-prefix": false,
88
"no-multiple-blanks": { "maximum": 5 }
99
},
10+
"vscodeGoogleTranslate.preferredLanguage": "uk",
1011
"cSpell.words": [
1112
"GRAVATAR",
1213
"amancevice",
@@ -31,6 +32,12 @@
3132
"pylint",
3233
"strftime",
3334
"strptime",
34-
"submodules"
35+
"submodules",
36+
"Візуалізатор",
37+
"Скріншоти",
38+
"репозиторій",
39+
"репозиторію",
40+
"репозиторія",
41+
"скріншотів"
3542
]
3643
}

‎README-uk.md‎

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
<!-- # Data visualizer from SaveEcoBot. Calculate AQI -->
2+
# Візуалізатор вихідних даних з SaveEcoBot. Обчислює AQI
3+
4+
>**[Read in English :world_map:](README.md)**
5+
6+
<!-- This software up and run nice dashboard with metrics from CSV file and calculate AQI for PM2.5 and PM10 -->
7+
Це програмне забезпечення підготує та запустить панель з усіма показниками з CSV-файлу а також обчислить і покаже AQI для PM2.5 та PM10.
8+
9+
<!-- Air Quality Index calculations based on [this document](https://www.airnow.gov/sites/default/files/2018-05/aqi-technical-assistance-document-may2016.pdf) -->
10+
Розрахунки Індексу Якості Повітря (Air Quality Index) базуються на основі [цього документа](https://www.airnow.gov/sites/default/files/2018-05/aqi-technical-assistance-document-may2016.pdf)
11+
12+
![Як це виглядає](docs/en/images/first-view.png)
13+
14+
<!-- More screenshots and usage examples [here](docs/en/screenshots.md). -->
15+
Більше скріншотів та прикладів використання [наведено тут [en]](docs/en/screenshots.md).
16+
17+
---
18+
19+
## МЕНЮ <!-- omit in toc -->
20+
21+
* [Необхідне програмне забезпечення](#Необхідне-програмне-забезпечення)
22+
* [Використання](#Використання)
23+
* [Швидкий старт](#Швидкий-старт)
24+
* [Повсякденне використання](#Повсякденне-використання)
25+
* [Запуск](#Запуск)
26+
* [Зупинка](#Зупинка)
27+
* [Датчики](#Датчики)
28+
* [Оброблення нових даних](#Оброблення-нових-даних)
29+
* [Додавання нових даних](#Додавання-нових-даних)
30+
* [Видалення даних](#Видалення-даних)
31+
* [Повне очищення](#Повне-очищення)
32+
* [Плани на майбутнє](#Плани-на-майбутнє)
33+
* [Хочете допомоги?](#Хочете-допомоги)
34+
* [Ліцензія та авторські права](#Ліцензія-та-авторські-права)
35+
36+
---
37+
38+
<!-- ## Required software -->
39+
## Необхідне програмне забезпечення
40+
41+
* [`Docker`](https://docs.docker.com/get-docker/)
42+
* [`docker-compose`](https://docs.docker.com/compose/install/) (для Linux)
43+
44+
<!-- ## Usage -->
45+
## Використання
46+
47+
<!-- ### Quick start -->
48+
### Швидкий старт
49+
50+
<!-- 1. Clone this repo or [download it as zip](https://github.com/MaxymVlasov/eco-data-visualizer/archive/master.zip) and unpack. -->
51+
1. Зклонуйте цей репозиторій або [завантажте його як zip архів](https://github.com/MaxymVlasov/eco-data-visualizer/archive/master.zip) і розпакуйте.
52+
53+
<!-- 2. Choose SaveEcoBot station [on this map](https://www.saveecobot.com/en/maps) and click 'Details' -->
54+
2. Виберіть станцію SaveEcoBot [на цій карті](https://www.saveecobot.com/uk/maps) та натисніть "Детальна інформація про станцію"
55+
![map-details.png](docs/uk/images/map-details.png)
56+
57+
<!-- 3. On bottom you'll see `Download raw data (CSV)` -->
58+
<!-- click on the link and save CSV-file to `./data/original_data/` inside downloaded repo. -->
59+
1. Унизу ви побачите "Завантажити дані у форматі CSV"
60+
![download-csv.png](docs/uk/images/download-csv.png)
61+
натисніть на посилання і збережіть CSV-файл у `./data/original_data/` всередині завантаженого репозиторію.
62+
63+
<!-- 4. Open terminal in the root of `eco-data-visualizer` and run: -->
64+
4. Відкрийте термінал у корені `eco-data-visualizer` і виконайте:
65+
66+
```bash
67+
# Підготовка даних
68+
docker build -t data-transformer ./data-transformer-app
69+
docker run -v "$PWD"/data/:/app/data/ --rm data-transformer
70+
# Запуск візуалізації
71+
docker-compose up -d
72+
# Додавання даних датчиків до InfluxDB
73+
docker build -t add_influx_data ./provisioning/influx
74+
docker run -v "$PWD"/data/influx/:/influx-data/ --rm --network=eco-data-visualizer_default add_influx_data
75+
```
76+
77+
<!-- ><sup>Depending on your internet bandwidth, CPU, Storage I/O, CSV file size and number of processed files `First Init` may take different times.
78+
For example, in laptop with `100Mbit/s` bandwidth, `Intel Core i7-8550U` (max clock speed `4Ghz`), SSD disk and:</sup>
79+
<sup> - 2 CSV files (together: 620MB) it takes `11m47s` (`9m39s` to transform data)</sup>
80+
<sup> - 1 CSV file (513MB) - `6m16s` (`4m18s` to transform data)</sup>
81+
<sup> - 1 CSV file (107MB) - `6m35s` (`4m32s` to transform data)</sup>
82+
-->
83+
<!-- markdownlint-disable no-inline-html -->
84+
><sup>Залежно від пропускної здатності вашого інтернет-каналу, параметрів процесора, жорсткого диску, розміру CSV-файлу та кількості оброблених файлів `Швидкий старт` може тривати різний час.
85+
Наприклад, у ноутбуці з пропускною здатністю `100 Мбіт/с`, `Intel Core i7-8550U` (максимальна тактова частота `4ГГц`), з SSD-диском та: </sup>
86+
<sup> - 2-ма файлами CSV (разом: 620MB) потрібно `11m47s` (з них `9m39s` для перетворення даних) </sup>
87+
<sup> - 1-ним файлом CSV (513MB) - `6m16s` (з них `4m18s` для перетворення даних) </sup>
88+
<sup> - 1-ним файлом CSV (107MB) - `6m35s` (з них `4m32s` для перетворення даних) </sup>
89+
<!-- markdownlint-enable no-inline-html -->
90+
91+
<!-- 5. Open [http://localhost/](http://localhost/) for see visualizations! -->
92+
5. Відкрийте [http://localhost/](http://localhost/), щоб побачити візуалізацію!
93+
94+
<!-- ### Daily usage -->
95+
### Повсякденне використання
96+
97+
<!-- #### Start -->
98+
#### Запуск
99+
100+
<!-- For start visualization open terminal in the root of repo and run: -->
101+
Для запуску візуалізації відкрийте термінал у корені репозиторія і виконайте:
102+
103+
```bash
104+
docker-compose up -d
105+
```
106+
107+
<!-- Then open [http://localhost/](http://localhost/) for see visualizations. -->
108+
Потім відкрийте [http://localhost/](http://localhost/), щоб побачити візуалізацію.
109+
110+
<!-- #### Stop -->
111+
#### Зупинка
112+
113+
<!-- For stop visualization open terminal in the root of repo and run: -->
114+
Для зупинки візуалізації відкрийте термінал у корені репозиторія і запустіть:
115+
116+
```bash
117+
docker-compose stop
118+
```
119+
120+
<!-- ### Sensors data -->
121+
### Датчики
122+
123+
<!-- #### Process new data -->
124+
#### Оброблення нових даних
125+
126+
<!-- 1. Download CSV file from SaveEcoBot station -->
127+
<!-- 2. Move it to `data/original_data` folder in this repo. -->
128+
1. Завантажте CSV-файл з SaveEcoBot
129+
2. Перемістіть його в теку `data/original_data` цього репозиторія.
130+
3. Виконайте:
131+
132+
```bash
133+
# Видалення тимчасових файлів
134+
docker run -v "$PWD"/data/:/app/ --rm amancevice/pandas:1.0.3-alpine sh -c "rm -f /app/csv/*.csv /app/influx/*.influx"
135+
# Підготовка даних
136+
docker build -t data-transformer ./data-transformer-app
137+
docker run -v "$PWD"/data/:/app/data/ --rm data-transformer
138+
```
139+
140+
<!-- #### Add new data -->
141+
#### Додавання нових даних
142+
143+
<!-- For add new data open terminal in the root of repo and run: -->
144+
Для додавання нових даних у візуалізацію відкрийте термінал у корені репозиторія і виконайте:
145+
146+
```bash
147+
# Запуск візуалізації
148+
docker-compose up -d
149+
# Додання нових даних
150+
docker build -t add_influx_data ./provisioning/influx
151+
docker run -v "$PWD"/data/influx/:/influx-data/ --rm --network=eco-data-visualizer_default add_influx_data
152+
```
153+
154+
<!-- #### Remove data -->
155+
#### Видалення даних
156+
157+
<!-- For remove sensors data open terminal in the root of repo and run: -->
158+
Для видалення даних датчиків з візуалізації відкрийте термінал у корені репозиторія і виконайте:
159+
160+
161+
```bash
162+
docker-compose down
163+
docker volume rm eco-data-visualizer_sensors-data
164+
```
165+
166+
<!-- ### Cleanup -->
167+
### Повне очищення
168+
169+
<!-- For cleanup open terminal in the root of repo and run: -->
170+
Для повного очищення відкрийте термінал у корені репозиторія і запустіть:
171+
172+
```bash
173+
# Зупинка візуалізації
174+
docker-compose down
175+
# Видалення томів з налаштуваннями та даними датчиків
176+
docker volume rm eco-data-visualizer_grafana-settings eco-data-visualizer_sensors-data
177+
# Видалення тимчасових файлів
178+
docker run -v "$PWD"/data/:/app/ --rm amancevice/pandas:1.0.3-alpine sh -c "rm -f /app/csv/*.csv /app/influx/*.influx"
179+
```
180+
181+
<!-- ## Future plans -->
182+
## Плани на майбутнє
183+
184+
Дивіться [відповідну секцію](README.md#future-plans) в англомовній версії.
185+
186+
<!-- markdownlint-disable no-trailing-punctuation -->
187+
<!-- ## Want help? -->
188+
## Хочете допомоги?
189+
<!-- markdownlint-enable no-trailing-punctuation -->
190+
191+
<!-- You can:
192+
* Improve this software (see [Future plans](#future-plans-) section)
193+
* [Donate to SaveEcoBot](https://www.saveecobot.com/en/donate)
194+
* Assemble or buy Air quality monitoring station and connect it to SaveEcoBot. SaveDnipro can assemble and connect it for you. [Buy here](https://www.savednipro.org/product/stanciya-monitoringu-yakosti-povitrya/) -->
195+
196+
Ви можете:
197+
198+
* Удосконалити це програмне забезпечення (див. розділ [Плани на майбутнє [en]](README.md#future-plans)).
199+
* [Зробити пожертву у SaveEcoBot](https://www.saveecobot.com/uk/donate).
200+
* Зібрати або придбати станцію контролю якості повітря та додати її до SaveEcoBot. SaveDnipro може зібрати і додати його для вас. [Замовляти тут](https://www.savednipro.org/product/stanciya-monitoringu-yakosti-povitrya/).
201+
202+
<!-- ## License and Copyrights -->
203+
## Ліцензія та авторські права
204+
205+
<!-- This software licensed by [Apache License 2.0](LICENSE) -->
206+
Це програмне забезпечення розповсюджується під ліцензією [Apache License 2.0](LICENSE).
207+
208+
<!-- All data from SaveEcoBot licensed by [Creative Commons Attribution License 4.0 International](https://creativecommons.org/licenses/by/4.0/legalcode) -->
209+
Усі дані з SaveEcoBot розповсюджуються під ліцензією [Creative Commons Attribution License 4.0 International](https://creativecommons.org/licenses/by/4.0/legalcode).
210+
211+
<!-- Other data and sources can be licensed in different way. -->
212+
Інші дані та джерела можуть мати інші ліцензії.

‎README.md‎

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Data visualizer from SaveEcoBot. Calculate AQI
22

3-
This software up and run nice dashboard with metrics from CSV file and calculate AQI for PM2.5 and PM10
3+
>**[Читати Українською :ukraine:](README-uk.md)**
4+
5+
This software up and run nice dashboard with metrics from CSV file and calculate AQI for PM2.5 and PM10.
46

57
Air Quality Index calculations based on [this document](https://www.airnow.gov/sites/default/files/2018-05/aqi-technical-assistance-document-may2016.pdf)
68

@@ -22,7 +24,7 @@ More screenshots and usage examples [here](docs/en/screenshots.md).
2224
* [Process new data](#process-new-data)
2325
* [Add new data](#add-new-data)
2426
* [Remove data](#remove-data)
25-
* [Cleanup](#cleanup)
27+
* [Full cleanup](#full-cleanup)
2628
* [Future plans](#future-plans)
2729
* [Want help?](#want-help)
2830
* [License and Copyrights](#license-and-copyrights)
@@ -45,19 +47,19 @@ More screenshots and usage examples [here](docs/en/screenshots.md).
4547

4648
3. On bottom you'll see `Download raw data (CSV)`
4749
![download-csv.png](docs/en/images/download-csv.png)
48-
click on them and save it to `eco-data-visualizer/data/original_data/` inside download repo.
50+
click on the link and save CSV-file to `./data/original_data/` inside downloaded repo.
4951

5052
4. Open terminal in the root of `eco-data-visualizer` and run:
5153

5254
```bash
53-
# Get data
55+
# Data preparation
5456
docker build -t data-transformer ./data-transformer-app
55-
docker run -v $PWD/data/:/app/data/ --rm data-transformer
57+
docker run -v "$PWD"/data/:/app/data/ --rm data-transformer
5658
# Run Grafana and DBs
5759
docker-compose up -d
5860
# Add data of sensors to InfluxDB
5961
docker build -t add_influx_data ./provisioning/influx
60-
docker run -v $PWD/data/influx/:/influx-data/ --rm --network=eco-data-visualizer_default add_influx_data
62+
docker run -v "$PWD"/data/influx/:/influx-data/ --rm --network=eco-data-visualizer_default add_influx_data
6163
```
6264
<!-- markdownlint-disable no-inline-html -->
6365
><sup>Depending on your internet bandwidth, CPU, Storage I/O, CSV file size and number of processed files `First Init` may take different times.
@@ -95,13 +97,14 @@ docker-compose stop
9597

9698
1. Download CSV file from SaveEcoBot station
9799
2. Move it to `data/original_data` folder in this repo.
100+
3. Run:
98101

99102
```bash
100103
# Remove temporary files
101-
docker run -v $PWD/data/:/app/ --rm amancevice/pandas:1.0.3-alpine sh -c "rm -f /app/csv/*.csv /app/influx/*.influx"
102-
# Get data
104+
docker run -v "$PWD"/data/:/app/ --rm amancevice/pandas:1.0.3-alpine sh -c "rm -f /app/csv/*.csv /app/influx/*.influx"
105+
# Data preparation
103106
docker build -t data-transformer ./data-transformer-app
104-
docker run -v $PWD/data/:/app/data/ --rm data-transformer
107+
docker run -v "$PWD"/data/:/app/data/ --rm data-transformer
105108
```
106109

107110
#### Add new data
@@ -113,34 +116,36 @@ For add new data open terminal in the root of repo and run:
113116
docker-compose up -d
114117
# Add new data
115118
docker build -t add_influx_data ./provisioning/influx
116-
docker run -v $PWD/data/influx/:/influx-data/ --rm --network=eco-data-visualizer_default add_influx_data
119+
docker run -v "$PWD"/data/influx/:/influx-data/ --rm --network=eco-data-visualizer_default add_influx_data
117120
```
118121

119122
#### Remove data
120123

124+
For remove sensors data open terminal in the root of repo and run:
125+
121126
```bash
122127
docker-compose down
123128
docker volume rm eco-data-visualizer_sensors-data
124129
```
125130

126-
### Cleanup
131+
### Full cleanup
127132

128133
For cleanup open terminal in the root of repo and run:
129134

130135
```bash
131136
# Stop services
132137
docker-compose down
133-
# Remove volumes with settings and user data
138+
# Remove volumes with settings and sensors data
134139
docker volume rm eco-data-visualizer_grafana-settings eco-data-visualizer_sensors-data
135140
# Remove temporary files
136-
docker run -v $PWD/data/:/app/ --rm amancevice/pandas:1.0.3-alpine sh -c "rm -f /app/csv/*.csv /app/influx/*.influx"
141+
docker run -v "$PWD"/data/:/app/ --rm amancevice/pandas:1.0.3-alpine sh -c "rm -f /app/csv/*.csv /app/influx/*.influx"
137142
```
138143

139144
## Future plans
140145

141146
* [ ] Add Ukrainian localization
142147
* [ ] Code and message dashboard localization
143-
* [ ] README.md localization
148+
* [ ] Docs localization
144149
* [ ] In Grafana Create personal graphs for each sensor with own good-bad color limits and so on as for AQI
145150
* [ ] Grab exist metrics from 'phenomenon' colum, use `SENSORS` content only for user friendly names and localization
146151
* [ ] Add AQI support for all specified in [doc](https://www.airnow.gov/sites/default/files/2018-05/aqi-technical-assistance-document-may2016.pdf)
@@ -154,14 +159,14 @@ docker run -v $PWD/data/:/app/ --rm amancevice/pandas:1.0.3-alpine sh -c "rm -f
154159

155160
You can:
156161

157-
* Improve this software (see [Future plans](#future-plans-) section)
158-
* [Donate to SaveEcoBot](https://www.saveecobot.com/en/donate)
159-
* Assemble or buy Air quality monitoring station and connect it to SaveEcoBot. SaveDnipro can assemble and connect it for you. [Buy here](https://www.savednipro.org/product/stanciya-monitoringu-yakosti-povitrya/)
162+
* Improve this software (see [Future plans](#future-plans-) section).
163+
* [Donate to SaveEcoBot](https://www.saveecobot.com/en/donate).
164+
* Assemble or buy Air quality monitoring station and connect it to SaveEcoBot. SaveDnipro can assemble and connect it for you. [Buy here](https://www.savednipro.org/product/stanciya-monitoringu-yakosti-povitrya/).
160165

161166
## License and Copyrights
162167

163-
This software licensed by [Apache License 2.0](LICENSE)
168+
This software licensed by [Apache License 2.0](LICENSE).
164169

165-
All data from SaveEcoBot licensed by [Creative Commons Attribution License 4.0 International](https://creativecommons.org/licenses/by/4.0/legalcode)
170+
All data from SaveEcoBot licensed by [Creative Commons Attribution License 4.0 International](https://creativecommons.org/licenses/by/4.0/legalcode).
166171

167172
Other data and sources can be licensed in different way.

‎docs/uk/images/download-csv.png‎

7.41 KB
Loading

‎docs/uk/images/map-details.png‎

19.1 KB
Loading

0 commit comments

Comments
 (0)