From 21f9e4a8686429cd0d497c7102ed6be292892eef Mon Sep 17 00:00:00 2001 From: kamangir Date: Sun, 14 Jul 2024 14:50:45 -0700 Subject: [PATCH] README refactor - kamangir/bolt#746 --- README.md | 76 ++--------------------- blue_geo/.abcli/QGIS/README.md | 33 ++++++++++ blue_geo/.abcli/ukraine-timemap/README.md | 40 ++++++++++++ blue_geo/.abcli/ukraine-timemap/ingest.sh | 4 +- blue_geo/__init__.py | 2 +- sources.yaml => metadata.yaml | 11 +++- setup.py | 3 +- 7 files changed, 90 insertions(+), 79 deletions(-) create mode 100644 blue_geo/.abcli/QGIS/README.md create mode 100644 blue_geo/.abcli/ukraine-timemap/README.md rename sources.yaml => metadata.yaml (66%) diff --git a/README.md b/README.md index 6074f2fa..68a8b81f 100644 --- a/README.md +++ b/README.md @@ -6,89 +6,23 @@ AI for precise geospatial data analysis and visualization. pip install blue-geo ``` ---- - -## QGIS - -```bash - > QGIS help -QGIS seed [screen] - . seed 🌱 QGIS. -QGIS expressions pull - . pull QGIS expressions. -QGIS expressions push [push] - . push QGIS expressions. - πŸ“‚ /Users/kamangir/Library/Application Support/QGIS/QGIS3/profiles/default/python/expressions - πŸ“‚ /Users/kamangir/git/blue-geo/blue_geo/QGIS/expressions -QGIS serve[r] [start] - . start QGIS server. -``` - -to start, generate the seed 🌱, - -```bash -QGIS seed -``` - -and paste it in the Python Console in QGIS. - -![image](https://github.com/kamangir/assets/blob/main/blue-geo/QGIS-python-console.png?raw=true) - ---- - | | | | |-|-|-| -| [QGIS](#QGIS) [ukraine-timemap](#ukraine-timemap-) πŸ‡ΊπŸ‡¦ πŸ”· [vancouver-watching](#vancouver-watching-) 🌈 | [sources](./metadata.yaml) | +| 🌐 [QGIS](./blue_geo/.abcli/QGIS/README.md) | πŸ‡ΊπŸ‡¦ [ukraine-timemap](./blue_geo/.abcli/ukraine-timemap/README.md) | 🌈 [vancouver-watching](https://github.com/kamangir/Vancouver-Watching) | +| [![image](https://github.com/kamangir/assets/blob/main/blue-geo/QGIS.png?raw=true)](./blue_geo/.abcli/QGIS/README.md) | [![image](https://github.com/kamangir/assets/blob/main/nbs/ukraine-timemap/QGIS.png?raw=true)](./blue_geo/.abcli/ukraine-timemap/README.md) | [![image](https://kamangir-public.s3.ca-central-1.amazonaws.com/test_vancouver_watching_ingest/animation.gif?raw=true)](https://github.com/kamangir/Vancouver-Watching) | +| an AI terraform for [QGIS](https://www.qgis.org/). | ingests the [Bellingcat](https://www.bellingcat.com/) [Civilian Harm in Ukraine TimeMap](https://github.com/bellingcat/ukraine-timemap) dataset, available through [this UI](https://ukraine.bellingcat.com/) and [this API](https://bellingcat-embeds.ams3.cdn.digitaloceanspaces.com/production/ukr/timemap/api.json), and generates a `geojson`, a QGIS project, and [more](https://kamangir-public.s3.ca-central-1.amazonaws.com/ukraine_timemap/ukraine_timemap.png). | 🌈 Vancouver watching with AI, last build: [πŸ”—](https://kamangir-public.s3.ca-central-1.amazonaws.com/test_vancouver_watching_ingest/animation.gif). | | -## ukraine-timemap πŸ‡ΊπŸ‡¦ -[`ukraine-timemap`](./blue_geo/.abcli/ukraine-timemap/) ingests the [Bellingcat](https://www.bellingcat.com/) [Civilian Harm in Ukraine TimeMap](https://github.com/bellingcat/ukraine-timemap) dataset, available through [this UI](https://ukraine.bellingcat.com/) and [this API](https://bellingcat-embeds.ams3.cdn.digitaloceanspaces.com/production/ukr/timemap/api.json), and generates a `geojson`, a QGIS project, and more. -```bash - > ukraine_timemap help -ukraine_timemap browse \ - [dataset|github] - . browse ukraine-timemap. -ukraine_timemap ingest \ - [dryrun,~upload] \ - [-|] \ - [--verbose 1] - . ingest the latest dataset from https://github.com/bellingcat/ukraine-timemap. -``` - -example use, - -``` -@select ukraine-timemap-$(@@timestamp) -ukraine_timemap ingest - . --verbose 1 -@open . QGIS -@publish tar . -``` - -![image](https://github.com/kamangir/assets/blob/main/nbs/ukraine-timemap/ingest_log.png?raw=true) - -latest ingested object: [ukraine-timemap.tar.gz](https://kamangir-public.s3.ca-central-1.amazonaws.com/ukraine_timemap.tar.gz), sandbox: [ukraine-timemap/sandbox.ipynb](./notebooks/ukraine-timemap/sandbox.ipynb). -last build [πŸ”—](https://kamangir-public.s3.ca-central-1.amazonaws.com/ukraine_timemap/ukraine_timemap.png) -![image](https://kamangir-public.s3.ca-central-1.amazonaws.com/ukraine_timemap/ukraine_timemap.png) - -![image](https://github.com/kamangir/assets/blob/main/nbs/ukraine-timemap/QGIS.png?raw=true) - -more: https://arash-kamangir.medium.com/%EF%B8%8F-openai-experiments-93-bf0cee062693 --- -## vancouver-watching 🌈 - -last build [πŸ”—](https://kamangir-public.s3.ca-central-1.amazonaws.com/test_vancouver_watching_ingest/animation.gif) - [github/kamangir/vancouver-watching](https://github.com/kamangir/vancouver-watching). - -![image](https://kamangir-public.s3.ca-central-1.amazonaws.com/test_vancouver_watching_ingest/animation.gif?raw=true) +[![PyPI version](https://img.shields.io/pypi/v/blue-geo.svg)](https://pypi.org/project/blue-geo/) -![image](https://github.com/kamangir/assets/blob/main/vanwatch/2024-01-06-20-39-46-73614-QGIS.gif?raw=true?raw=1) +πŸ“œ [metadata](./metadata.yaml) --- -[![PyPI version](https://img.shields.io/pypi/v/blue-geo.svg)](https://pypi.org/project/blue-geo/) - To use on [AWS SageMaker](https://aws.amazon.com/sagemaker/) replace `` with the name of the plugin and follow [these instructions](https://github.com/kamangir/notebooks-and-scripts/blob/main/SageMaker.md). diff --git a/blue_geo/.abcli/QGIS/README.md b/blue_geo/.abcli/QGIS/README.md new file mode 100644 index 00000000..084e534d --- /dev/null +++ b/blue_geo/.abcli/QGIS/README.md @@ -0,0 +1,33 @@ +# 🌐 QGIS + +🌐 an AI terraform for [QGIS](https://www.qgis.org/). + +```bash +pip install blue-geo +``` + +```bash + > QGIS help +QGIS seed [screen] + . seed 🌱 QGIS. +QGIS expressions pull + . pull QGIS expressions. +QGIS expressions push [push] + . push QGIS expressions. + πŸ“‚ /Users/kamangir/Library/Application Support/QGIS/QGIS3/profiles/default/python/expressions + πŸ“‚ /Users/kamangir/git/blue-geo/blue_geo/QGIS/expressions +QGIS serve[r] [start] + . start QGIS server. +``` + +to terraform QGIS, generate the seed 🌱, + +```bash +QGIS seed +``` + +and paste it in the Python Console in QGIS. + +![image](https://github.com/kamangir/assets/blob/main/blue-geo/QGIS-python-console.png?raw=true) + +![image](https://github.com/kamangir/assets/blob/main/blue-geo/QGIS.png?raw=true) \ No newline at end of file diff --git a/blue_geo/.abcli/ukraine-timemap/README.md b/blue_geo/.abcli/ukraine-timemap/README.md new file mode 100644 index 00000000..72cf1806 --- /dev/null +++ b/blue_geo/.abcli/ukraine-timemap/README.md @@ -0,0 +1,40 @@ +# ukraine-timemap πŸ‡ΊπŸ‡¦ + +`ukraine-timemap` ingests the [Bellingcat](https://www.bellingcat.com/) [Civilian Harm in Ukraine TimeMap](https://github.com/bellingcat/ukraine-timemap) dataset, available through [this UI](https://ukraine.bellingcat.com/) and [this API](https://bellingcat-embeds.ams3.cdn.digitaloceanspaces.com/production/ukr/timemap/api.json), and generates a `geojson`, a QGIS project, and more. + +```bash +pip install blue-geo +``` + +```bash + > ukraine_timemap help +ukraine_timemap browse \ + [dataset|github] + . browse ukraine-timemap. +ukraine_timemap ingest \ + [dryrun,~upload] \ + [-|] \ + [--verbose 1] + . ingest the latest dataset from https://github.com/bellingcat/ukraine-timemap. +``` + +example use, + +``` +@select ukraine-timemap-$(@@timestamp) +ukraine_timemap ingest - . --verbose 1 +@open . QGIS +@publish tar . +``` + +![image](https://github.com/kamangir/assets/blob/main/nbs/ukraine-timemap/ingest_log.png?raw=true) + +latest ingested object: [ukraine-timemap.tar.gz](https://kamangir-public.s3.ca-central-1.amazonaws.com/ukraine_timemap.tar.gz), sandbox: [ukraine-timemap/sandbox.ipynb](./notebooks/ukraine-timemap/sandbox.ipynb). + +last build [πŸ”—](https://kamangir-public.s3.ca-central-1.amazonaws.com/ukraine_timemap/ukraine_timemap.png) + +![image](https://kamangir-public.s3.ca-central-1.amazonaws.com/ukraine_timemap/ukraine_timemap.png) + +![image](https://github.com/kamangir/assets/blob/main/nbs/ukraine-timemap/QGIS.png?raw=true) + +more: https://arash-kamangir.medium.com/%EF%B8%8F-openai-experiments-93-bf0cee062693 \ No newline at end of file diff --git a/blue_geo/.abcli/ukraine-timemap/ingest.sh b/blue_geo/.abcli/ukraine-timemap/ingest.sh index 24241f2c..cca0e6db 100644 --- a/blue_geo/.abcli/ukraine-timemap/ingest.sh +++ b/blue_geo/.abcli/ukraine-timemap/ingest.sh @@ -42,8 +42,8 @@ function ukraine_timemap_ingest() { local open_options=$3 local do_open=$(abcli_option_int "$open_options" open 0) [[ "$do_open" == 1 ]] && - abcli_open $object_name \ - QGIS,$open_options + abcli_open QGIS,$open_options \ + $object_name return 0 } diff --git a/blue_geo/__init__.py b/blue_geo/__init__.py index 214db487..af789156 100644 --- a/blue_geo/__init__.py +++ b/blue_geo/__init__.py @@ -4,7 +4,7 @@ DESCRIPTION = f"{ICON} AI for precise geospatial data analysis and visualization." -VERSION = "4.37.1" +VERSION = "4.38.1" REPO_NAME = "blue-geo" diff --git a/sources.yaml b/metadata.yaml similarity index 66% rename from sources.yaml rename to metadata.yaml index 91228073..928094d8 100644 --- a/sources.yaml +++ b/metadata.yaml @@ -1,16 +1,21 @@ -list: +applications: ukraine_timemap: - url: https://github.com/kamangir/blue-geo?ukraine-timemap- + url: https://github.com/kamangir/blue-geo/tree/main/blue_geo/.abcli/ukraine-timemap callable: ukraine_timemap + QGIS-application: ukraine_timemap association: bellingcat vancouver_watching: url: https://github.com/kamangir/Vancouver-Watching callable: vancouver_watching + QGIS-application: vancouver_watching vis_tj_kg_map_2022: url: https://github.com/bellingcat/vis-tj-kg-map-2022 - callable: not_available + callable: comments: before/after non-geo-tagged high-res images of conflict zones. association: bellingcat +datacube-sources: + firms: + url: https://firms.modaps.eosdis.nasa.gov/map/ associations: bellingcat: urls: diff --git a/setup.py b/setup.py index 15966daa..3647ae3e 100644 --- a/setup.py +++ b/setup.py @@ -14,8 +14,7 @@ NAME: [ "config.env", ".abcli/**/*.sh", + "**/README.md", ], }, ) - -