aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorevansiroky <evan.siroky@yahoo.com>2018-11-16 22:32:16 -0800
committerevansiroky <evan.siroky@yahoo.com>2018-11-16 22:32:16 -0800
commit699b412b4ed89c48a9d35407d11bbbe8c652a5f4 (patch)
tree3cc30a9df1396dbaefa00e3e5253ec1dacae3575
parent4af5e126f1a6c30c09b50199ca94608bf874f103 (diff)
downloadtimezone-boundary-builder-699b412b4ed89c48a9d35407d11bbbe8c652a5f4.tar.gz
update readme, changelog in anticipation of 2018g release
-rw-r--r--2018d.pngbin383041 -> 0 bytes
-rw-r--r--2018g.pngbin0 -> 457483 bytes
-rw-r--r--CHANGELOG.md36
-rw-r--r--README.md12
4 files changed, 26 insertions, 22 deletions
diff --git a/2018d.png b/2018d.png
deleted file mode 100644
index 0cd2375..0000000
--- a/2018d.png
+++ /dev/null
Binary files differ
diff --git a/2018g.png b/2018g.png
new file mode 100644
index 0000000..bef2e3b
--- /dev/null
+++ b/2018g.png
Binary files differ
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 40d66b0..4bd0cf1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,26 +1,28 @@
-## Unreleased
+## 2018g
### Zone Changes
-* Switch geometries of America/Danmarkshavn and America/Scoresbysund ([#40](https://github.com/evansiroky/timezone-boundary-builder/issues/40))
+* Switch geometries of `America/Danmarkshavn` and `America/Scoresbysund` ([#40](https://github.com/evansiroky/timezone-boundary-builder/issues/40))
* Add timezones in Antarctica ([#42](https://github.com/evansiroky/timezone-boundary-builder/issues/42))
-* Fix northern border of America/Argentina/Rio_Gallegos ([#46](https://github.com/evansiroky/timezone-boundary-builder/issues/46))
+* Fix northern border of `America/Argentina/Rio_Gallegos` ([#46](https://github.com/evansiroky/timezone-boundary-builder/issues/46))
* Allow timezone boundaries to overlap. ([#41](https://github.com/evansiroky/timezone-boundary-builder/issues/41))
* This change now means that the following zones overlap:
- * Africa/Juba, Africa/Khartoum
- * America/Argentina/Rio_Gallegos, America/Punta_Arenas
- * America/La_Paz, America/Porto_Velho
- * America/Moncton, America/New_York
- * Asia/Hebron, Asia/Jerusalem
- * Asia/Ho_Chi_Minh, Asia/Manila
- * Asia/Ho_Chi_Minh, Asia/Shanghai
- * Asia/Manila, Asia/Shanghai
- * Asia/Shanghai, Asia/Taipei
- * Asia/Shanghai, Asia/Urumqi
- * Europe/Amsterdam, Europe/Berlin
- * Europe/Belgrade, Europe/Zagreb
- * Europe/Berlin, Europe/Luxembourg
- * Europe/Paris, Europe/Rome
+ * `Africa/Juba`, `Africa/Khartoum`
+ * `America/Argentina/Rio_Gallegos`, `America/Punta_Arenas`
+ * `America/La_Paz`, `America/Porto_Velho`
+ * `America/Moncton`, `America/New_York`
+ * `Asia/Hebron`, `Asia/Jerusalem`
+ * `Asia/Ho_Chi_Minh`, `Asia/Manila`
+ * `Asia/Ho_Chi_Minh`, `Asia/Shanghai`
+ * `Asia/Manila`, `Asia/Shanghai`
+ * `Asia/Shanghai`, `Asia/Taipei`
+ * `Asia/Shanghai`, `Asia/Urumqi`
+ * `Europe/Amsterdam`, `Europe/Berlin`
+ * `Europe/Belgrade`, `Europe/Zagreb`
+ * `Europe/Berlin`, `Europe/Luxembourg`
+ * `Europe/Paris`, `Europe/Rome`
+* Add disupted area near Doklam to `Asia/Shanghai` and `Asia/Thimphu` ([#49](https://github.com/evansiroky/timezone-boundary-builder/issues/49))
+* Update boundaries of `America/Creston` and `America/Edmonton` to reflect changes in OpenStreetMap
* Update to latest OSM data
### Other Changes
diff --git a/README.md b/README.md
index 710f749..0f5be4d 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
The goal of this project is to produce a shapefile with the boundaries of the world's timezones using OpenStreetMap data.
-<p align="center"><img src="2018d.png" /></p>
+<p align="center"><img src="2018g.png" /></p>
## Shapefiles and data
@@ -10,7 +10,7 @@ The shapefiles are available for download in this project's [releases](https://g
This project aims to stay up-to-date with all of the currently valid timezones that are defined in the timezone database. This project also will attempt to provide the most accurate possible boundaries of timezones according to community input.
-The underlying data is download from [OpenStreetMap](http://www.openstreetmap.org/) via the [overpass turbo API](http://overpass-turbo.eu/). Various boundaries are assembled together to produce each zone with various geographic operations. In numerous edge cases arbitrary boundaries get created in various zones which are noted in the `timezones.json` file.
+The underlying data is downloaded from [OpenStreetMap](http://www.openstreetmap.org/) via the [overpass turbo API](http://overpass-turbo.eu/). Various boundaries are assembled together to produce each zone with various geographic operations. In numerous edge cases arbitrary boundaries get created in various zones which are noted in the `timezones.json` file.
To maintain consistency with the timezone database, this project will only create a new release after the timezone database creates a new release. If there are no new timezones created or deleted in a timezone database release, then this project will only create a release if there have been changes performed to the boundary definitions of an existing zone within this project.
@@ -52,13 +52,15 @@ node --max-old-space-size=8192 index.js --filtered-zones "America/New_York,Ameri
### What the script does
-There are two config files that describe the boundary building process. The `osmBoundarySources.json` file lists all of the needed boundaries to extract via queries to the Overpass API. The `timezones.json` file lists all of the timezones and various operations to perform to build the boundaries. The `index.js` file downloads all of the required geometries, builds the specified geometries, validates that there aren't large areas of overlap, outputs one huge geojson file, and finally zips up the geojson file using the `zip` cli and also converts the geojson to a shapefile using the `ogr2ogr` cli. The script has only been verified to run with Node.js 6 on the MacOS platform.
+There are three config files that describe the boundary building process. The `osmBoundarySources.json` file lists all of the needed boundaries to extract via queries to the Overpass API. The `timezones.json` file lists all of the timezones and various operations to perform to build the boundaries. The `expectedZoneOverlaps.json` file lists all timezones that are allowed to overlap each other and the acceptable bounds of a particular overlap.
+
+The `index.js` file downloads all of the required geometries, builds the specified geometries, validates that there aren't large areas of overlap (other than those that are expected), outputs one huge geojson file, and finally zips up the geojson file using the `zip` cli and also converts the geojson to a shapefile using the `ogr2ogr` cli. The script has only been verified to run with Node.js 6 on the MacOS platform.
The code does query the publicly available overpass API, but it self-throttles the making of requests to have a minimum of 4 seconds gap between requests. If the Overpass API throttles the download, then the gap will be increased exponentially.
## Limitations of this project
-The data is almost completely comprised of OpenStreetMap data which is editable by anyone. There are a few guesses on where to draw an arbitrary border in the open waters and a few sparsely inhabited areas. Some uninhabited islands are omitted from this project. This project does include timezones in the oceans, but strictly uses territorial waters or Etc/GMT timezones instead of unofficially observed areas such as Exclusive Economic Zones. All of Antarctica is currently omitted and instead shows up as a Etc/GMT timezone as if it were the ocean.
+The data is almost completely comprised of OpenStreetMap data which is editable by anyone. There are a few guesses on where to draw an arbitrary border in the open waters and a few sparsely inhabited areas. Some uninhabited islands are omitted from this project. This project does include timezones in the oceans, but strictly uses territorial waters or Etc/GMT timezones instead of unofficially observed areas such as Exclusive Economic Zones.
## Contributing
@@ -72,7 +74,7 @@ Will be approved subject to code review.
Any change to the boundary of existing timezones must have some explanation of why the change is necessary. If there are official, publicly available documents of administrative areas describing their timezone boundary please link to them when making your case. All changes involving an administrative area changing their observed time should instead be sent to the [timezone database](https://www.iana.org/time-zones).
-A linting script will verify the integrity of the `timezones.json` and `osmBoundarySources.json` files. The script verifies if all needed overpass sources are properly defined and that there aren't any unneeded overpass downloads. If an operation to make a timezone boundary requires the use of a manual geometry, a description must be added explaining the operation.
+A linting script will verify the integrity of the `timezones.json`, `osmBoundarySources.json` and `expectedZoneOverlaps.json` files. The script verifies if all needed overpass sources are properly defined and that there aren't any unneeded overpass downloads. If an operation to make a timezone boundary requires the use of a manual geometry, a description must be added explaining the operation. All expected zone overlaps must have a description.
## Thanks