Improve maps_generator README. #4404

2023-02-05T19:57:12Z

hallahan commented

2023-02-05 19:57:12 +00:00

(Migrated from github.com)

I tweaked some of the English wording in this doc. My intent is to make this a bit easier to understand to a newcomer that wants to generate some .mwm files themselves.

cc/ @endim8 @biodranik

Inspired by:
organicmaps/organicmaps#4392

Related issues:
organicmaps/organicmaps#4405
organicmaps/organicmaps#4406

I tweaked some of the English wording in this doc. My intent is to make this a bit easier to understand to a newcomer that wants to generate some .mwm files themselves. cc/ @endim8 @biodranik Inspired by: https://git.omaps.dev/organicmaps/organicmaps/issues/4392 Related issues: https://git.omaps.dev/organicmaps/organicmaps/issues/4405 https://git.omaps.dev/organicmaps/organicmaps/issues/4406

👍 1

biodranik (Migrated from github.com) requested changes 2023-02-06 09:24:42 +00:00

tools/python/maps_generator/README.md

biodranik (Migrated from github.com) commented

2023-02-06 09:13:38 +00:00

You don't need the desktop app for the generator.

biodranik (Migrated from github.com) commented

2023-02-06 09:15:26 +00:00

Why 1. ?

Did you preview it? Was the markdown with numbered items rendered correctly?

Why 1. ? Did you preview it? Was the markdown with numbered items rendered correctly?

biodranik (Migrated from github.com) commented

2023-02-06 09:16:56 +00:00

Here is a sample ini that will download an OSM PBF file for the Yukon Territories, Canada from [GEOFABRIK](https://www.geofabrik.de/). You can replace the *osm.pbf* and *osm.pbf.md5* with other areas instead. Note that an entire planet file currently takes 40+ hours on a server with 256GB of RAM. Unless you have a machine this large, it is recommended to use a smaller extract.

```suggestion Here is a sample ini that will download an OSM PBF file for the Yukon Territories, Canada from [GEOFABRIK](https://www.geofabrik.de/). You can replace the *osm.pbf* and *osm.pbf.md5* with other areas instead. Note that an entire planet file currently takes 40+ hours on a server with 256GB of RAM. Unless you have a machine this large, it is recommended to use a smaller extract. ```

tools/python/maps_generator/README.md

				`@ -63,17 +68,15 @@ MAIN_OUT_PATH: ~/maps_build`

biodranik (Migrated from github.com) commented

2023-02-06 09:17:46 +00:00

# The path to the data folder in the repository.

```suggestion # The path to the data folder in the repository. ```

tools/python/maps_generator/README.md

					
				@ -124,26 +139,34 @@ SUBWAY_URL: https://cdn.organicmaps.app/subway.json

				# UK_POSTCODES_URL:

biodranik (Migrated from github.com) commented

2023-02-06 09:19:55 +00:00

python$ python -m maps_generator -h

```suggestion python$ python -m maps_generator -h ```

tools/python/maps_generator/README.md

					
				@ -195,22 +218,19 @@ optional arguments:

				  --order ORDER         Mwm generation order.

biodranik (Migrated from github.com) commented

2023-02-06 09:20:14 +00:00

If you are not from the Organic Maps team, then you do not need the option --production when generating maps.

```suggestion If you are not from the Organic Maps team, then you do not need the option --production when generating maps. ```

tools/python/maps_generator/README.md

biodranik (Migrated from github.com) commented

2023-02-06 09:21:51 +00:00

It is only needed in the case of building some regions. If the whole planet is built, then these files will be generated/used directly.

biodranik (Migrated from github.com) commented

2023-02-06 09:22:41 +00:00

python$ python -m maps_generator -c --from_stage="Routing" --countries="Japan_Kinki Region_Osaka_Osaka, Japan_Chugoku Region_Tottori"

Please check if there are other 3.6 hardcoded versions somewhere.

```suggestion python$ python -m maps_generator -c --from_stage="Routing" --countries="Japan_Kinki Region_Osaka_Osaka, Japan_Chugoku Region_Tottori" ``` Please check if there are other 3.6 hardcoded versions somewhere.

tools/python/maps_generator/README.md

					
				@ -272,12 +294,12 @@ PLANET_MD5_URL: https://download.geofabrik.de/russia/central-fed-district-latest

				3. Run

biodranik (Migrated from github.com) commented

2023-02-06 09:23:18 +00:00

python$ python -m maps_generator --countries="Japan_Chugoku Region_Tottori" --skip="Coastline"

```suggestion python$ python -m maps_generator --countries="Japan_Chugoku Region_Tottori" --skip="Coastline" ```

hallahan (Migrated from github.com) reviewed 2023-02-06 16:50:03 +00:00

tools/python/maps_generator/README.md

hallahan (Migrated from github.com) commented

2023-02-06 16:50:03 +00:00

Whoops, fixing.

hallahan (Migrated from github.com) reviewed 2023-02-06 16:58:15 +00:00

tools/python/maps_generator/README.md

hallahan (Migrated from github.com) commented

2023-02-06 16:58:15 +00:00

Are you saying that this part of the config can be left blank in a planet build? For this example, we are doing all of Japan.

I have found that the generator fails if I include World and WorldCoasts, at least for the Yukon. So aren't the geom files always required?

Are you saying that this part of the config can be left blank in a planet build? For this example, we are doing all of Japan. I have found that the generator fails if I include World and WorldCoasts, at least for the Yukon. So aren't the geom files always required?