From 13ed864ca949970491e438280629cda948f26286 Mon Sep 17 00:00:00 2001 From: Oliver Tonnhofer Date: Mon, 2 Sep 2013 09:11:17 +0200 Subject: [PATCH] add README/LICENSE --- LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 217 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 419 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..de7762f --- /dev/null +++ b/README.md @@ -0,0 +1,217 @@ +Imposm 3 +======== + +Imposm is an importer for OpenStreetMap data. It reads PBF files and +imports the data into PostgreSQL/PostGIS. It can also update the +DB from diff files. + +It is designed to create databases that are optimized for rendering (i.e. generating tiles or for WMS services). + +Imposm 3 is written in Go and it is a complete rewrite of the previous Python implementation. +Configurations/mappings and cache files are not compatible with Imposm 2, but they share a similar architecture. + + +It is released as open source under the [Apache License 2.0][]. + +[Apache License 2.0]: http://www.apache.org/licenses/LICENSE-2.0.html + + +The development of Imposm 3 was sponsored by [Omniscale](http://omniscale.com/) and development will continue as resources permit. +Please get in touch if you need commercial support or if you need specific features. + + +Features +-------- + +* High-performance +* Diff support +* Custom database schemas +* Generalized geometries + + +### In detail + + +- High performance: + Parallel from the ground up. It distributes parsing and processing to all available CPU cores. + +- Custom database schemas: + Creates tables for different data types. This allows easier styling and better performance for rendering in WMS or tile services. + +- Unify values: + For example, the boolean values `1`, `on`, `true` and `yes` all become ``TRUE``. + +- Filter by tags and values: + Only import data you are going to render/use. + +- Efficient nodes cache: + It is necessary to store all nodes to build ways and relations. Imposm uses a file-based key-value database to cache this data. + +- Generalized tables: + Automatically creates tables with lower spatial resolutions, perfect for rendering large road networks in low resolutions. + +- Limit to polygons: + Limit imported geometries to polygons from Shapefiles or GeoJSON, for city/state/country imports. + +- Easy deployment: + Single binary with only runtime dependencies to common libs (GEOS, GDAL, SQLite and LevelDB) + +- Support for table namespace (PostgreSQL schema) + + +### Performance ### + +Imposm 3 is much faster then Imposm 2 and osm2pgsql. + +* Makes full use of all available CPU cores +* Bulk inserts into PostgreSQL with `COPY FROM` +* Efficient intermediate cache for reduced IO load during ways and relations building + + +Some import times from a Hetzner EX 4S server (Intel i7-2600 CPU @ 3.40GHz, 32GB RAM and 2TB software RAID1 (2x2TB 7200rpm SATA disks)) for imports of a 20.5GB planet PBF (2013-06-14) with generalized tables: + +* 6:30h in normal-mode +* 13h in diff-mode + +osm2pgsql required between 2-8 days in a [similar benchmark (slide 7)](http://www.geofabrik.de/media/2012-09-08-osm2pgsql-performance.pdf) with a smaller PBF file (~15GB). + +Import of Europe 11GB PBF with generalized tables on the same server: + +* 2:20h in normal-mode + +Benchmarks with SSD are TBD. + + +Current status +-------------- + +Imposm 3 is in alpha stadium and there is no official release yet. +The import itself is working however and it was already used for production databases. + +### Missing ### + +* Documentation +* Updating generalized tables in diff-mode +* Automatic download of diff files +* Tile expire list for re-rendering updated areas +* Background mode for diff-import (update DB in background) +* Diff import into custom PG schemas +* Support for other projections than EPSG:3857 +* Improve parallelization of diff import + +Installation +------------ + +### Dependencies ### + +#### Compiler + +You need [Go >=1.1](http://golang.org). + +#### C/C++ libraries + +Other dependencies are [libleveldb][], [libgeos][], [libgdal][] and [libsqlite3][]. +Imposm 3 was tested with recent versions of these libraries, but you might succeed with older versions. +GEOS >=3.2 is recommended, since it became much more robust when handling invalid geometries. + +[libleveldb]: +[libgeos]: +[libgdal]: +[libsqlite3]: + +#### Go libraries + +Imposm3 uses the following libraries. `go install` will fetch these: + +- +- +- +- +- + +### Installation ### + +Create a new `GOPATH` + + mkdir imposm + cd imposm + export GOPATH=`pwd` + +Get Imposm 3 and all dependencies: + + mkdir src + git clone https://github.com/omniscale/imposm3 src/imposm3 + go install imposm3 + +Done. You should now have an imposm3 binary in `$GOPATH/bin`. + +Go compiles to static binaries and so Imposm 3 has no runtime dependencies to Go. +Just copy the `imposm3` binary to your server for deployment. The C/C++ libraries listed above are still required though. + + + +Usage +----- + +`imposm3` has multiple subcommands. Use `imposm3 import` for basic imports. + +For a simple import: + + imposm3 import -connection postgis://user:password@host/database -mapping mapping.json -read /path/to/osm.pbf -write + +You need a JSON file with the target database mapping. See `example-mapping.json` to get an idea what is possible with the mapping. + +Imposm creates all new tables inside the `import` table schema. So you'll have `import.osm_roads` etc. You can change the tables to the `public` schema: + + imposm3 import -connection postgis://user:passwd@host/database -mapping mapping.json -deployproduction + + +You can write some options into a JSON configuration file: + + { + "cachedir": "/var/local/imposm3", + "mapping": "mapping.json", + "connection": "postgis://user:password@localhost:port/database", + } + +To use that config: + + imposm3 import -config config.json [args...] + +For more options see: + + imposm3 import -help + +Sorry, that's all documentation for the moment. + + +Support +------- + +There is a [mailing list at Google Groups](http://groups.google.com/group/imposm) for all questions. You can subscribe by sending an email to: `imposm+subscribe@googlegroups.com` + +For commercial support [contact Omniscale](http://omniscale.com/contact). + +Development +----------- + +The source code is available at: + +You can report any issues at: + +### Test ### + +#### Unit tests #### + + go test imposm3/... + + +#### System tests #### + +There is a system test that imports and updates OSM data and verifies the database content. +This test is written in Python and requires `nose`, `shapely` and `psycopg2`. + +WARNING: It uses your local PostgeSQL database (`import` schema), if you have one. Change the database with the standard PGXXX environment variables. + + cd test + nosetests test.py