From d237ad85e0b3d15b42670f24d1d71c4566b0d299 Mon Sep 17 00:00:00 2001 From: Rob Savoye Date: Sun, 17 Sep 2023 09:22:24 +0700 Subject: [PATCH] fix: Update doc to match code changes --- docs/about/make_data_extract.md | 87 +++++++++------------------------ 1 file changed, 23 insertions(+), 64 deletions(-) diff --git a/docs/about/make_data_extract.md b/docs/about/make_data_extract.md index f296a773..dcdb4654 100644 --- a/docs/about/make_data_extract.md +++ b/docs/about/make_data_extract.md @@ -5,37 +5,32 @@ The `make_data_extract.py` program is used to extract OpenStreetMap Collect. This function allows users to select from a list of options generated from an external file. The `make_data_extract.py` program creates a data extract that can be used as an external file with the -`select_one_from_file` function. The data extract can be created using -Overpass Turbo or a Postgres database. +XLSForm. The data extract can be created using local Postgres +database, or the remote Underpass database. To use the new `select_one_from_file` for editing existing OSM data you need to produce a data extract from OSM. This can be done several ways, but needed to be automated to be used for FMTM. options: - -h, --help show this help message and exit - -v, --verbose verbose output - -o, --overpass Use Overpass Turbo - -p, --postgres Use a postgres database - -g GEOJSON, --geojson GEOJSON Name of the GeoJson output file - -i INFILE, --infile INFILE Use a data file - -dn DBNAME, --dbname DBNAME Database name - -dh DBHOST, --dbhost DBHOST Database host - -b BOUNDARY, --boundary BOUNDARY Boundary polygon to limit the data size - -c {buildings,amenities}, --category {buildings,amenities} - Which category to extract + --help (-h) show this help message and exit + --verbose (-v) verbose output + --geojson (-g) GEOJSON Name of the GeoJson output file + --boundary (-b) BOUNDARY Boundary polygon to limit the data size + --category (-c) CATEGORY Which category to extract + --uri (-u) URI Database URI + --xlsfile (-x) XLSFILE An XLSForm in the library + --list (-l) List List all XLSForms in the library ## Examples -### Postgres Database: - -The --postgres option uses a Postgres database to extract OSM data. By +Make_data_extract uses a Postgres database to extract OSM data. By default, the program uses **localhost** as the database host. If you use **underpass* as the data base name, this will remotely access the [Humanitarian OpenStreetMap Team(HOT)](https://www.hotosm.org) maintained OSM database that covers the entire planet, and is updated every minute. The name of the database can be specified using the -_--dbname_ option. The program extracts the buildings category of OSM +*--uri*_ option. The program extracts the buildings category of OSM data by default. The size of the extracted data can be limited using the _--boundary_ option. The program outputs the data in GeoJSON format. @@ -62,7 +57,7 @@ more compressed and efficient data schema. ### Example: - ./make_data_extract.py --postgres -dn colorado --boundary mycounty.geojson -g mycounty_buildings.geojson + ./make_data_extract.py -u colorado --boundary mycounty.geojson -g mycounty_buildings.geojson This example extracts the `buildings` category of OSM data from a Postgres database named `colorado`. The program limits the size of the @@ -70,37 +65,21 @@ extracted data to the boundary specified in the `mycounty.geojson` file. The program outputs the data in GeoJSON format to a file named `mycounty_buildings.geojson`. -### Input File: - -The `--infile` option can be used to specify an input file in OSM XML, -OSM PBF, or GeoJSON format. The program extracts the `buildings` -category of OSM data by default. The program outputs the data in -GeoJSON format. This can be used instead of a database. - -### Example: - - ./make_data_extract.py --infile mydata.osm.pbf -g mydata_buildings.geojson - -This example extracts the `buildings` category of OSM data from an -input file in OSM PBF format named `mydata.osm.pbf`. The program -outputs the data in GeoJSON format to a file named -`mydata_buildings.geojson`. - ### Boundary: The `--boundary` option can be used to specify a polygon boundary to -limit the size of the extracted data. The boundary can be specified in -GeoJSON format. +limit the size of the extracted data. The boundary has to be in +GeoJSON format, both multipolygons and polygons are supported. Example: - ./make_data_extract.py --postgres -dn colorado --category buildings --boundary mycounty.geojson -g mycounty_buildings.geojson + ./make_data_extract.py -u foo@colorado --category healthcare --boundary mycounty.geojson -g mycounty_healthcare.geojson -This example extracts the `buildings` category of OSM data from a -Postgres database named `colorado`. The program limits the size of the -extracted data to the boundary specified in the `mycounty.geojson` -file. The program outputs the data in GeoJSON format to a file named -`mycounty_buildings.geojson`. +This example extracts the `healthcare` category of OSM data from a +Postgres database named `colorado` with e user *foo*. The program +limits the size of the extracted data to the boundary specified in the +`mycounty.geojson` file. The program outputs the data in GeoJSON +format to a file named `mycounty_healtcare.geojson`. ### Category: @@ -110,7 +89,7 @@ library](https://github.com/hotosm/osm-fieldwork/tree/main/osm_fieldwork/xlsform ### Example: - ./make_data_extract.py --overpass --boundary mycounty.geojson --category amenities -g mycounty_amenities.geojson + ./make_data_extract.py -u underpass --boundary mycounty.geojson --category amenities -g mycounty_amenities.geojson This example uses Overpass Turbo to extract the `amenities` category of OSM data within the boundary specified in the `mycounty.geojson` @@ -124,27 +103,7 @@ of the output file can be specified using the `--geojson option`. If the option is not specified, the program uses the input file name with `_buildings.geojson` appended to it. - ./make_data_extract.py --overpass --boundary mycounty.geojson -g mycounty_buildings.geojson - -This example uses Overpass Turbo to extract the `buildings` category -of OSM data within the boundary specified in the `mycounty.geojson` -file. The program outputs the data in GeoJSON format to a file named -`mycounty_buildings.geojson`. - -### Overpass Turbo: -The `--overpass` option uses Overpass Turbo to extract OSM data. By -default, the program extracts the `buildings` category of OSM -data. The size of the extracted data can be limited using the -`--boundary` option. The program outputs the data in GeoJSON format. - -### Example: - - ./make_data_extract.py --overpass --boundary mycounty.geojson -g mycounty_buildings.geojson - -This example uses Overpass Turbo to extract the `buildings` category -of OSM data within the boundary specified in the `mycounty.geojson` -file. The program outputs the data in GeoJSON format to a file named -`mycounty_buildings.geojson`. + ./make_data_extract.py -u colorado --boundary mycounty.geojson -g mycounty_buildings.geojson ## File Formats