Repository files navigation

High performance Scala library and Spark Polyglot (Scala, Python, SQL, etc.) connector for OpenStreetMap Pbf files.

⚠ Full usage documentation athttps://simplexspatial.github.io/osm4scala/

It's possible to develop using a Windows machine, but all documentation suppose that you are using Linux or Mac.

The only special requirement is to executesbt compile to generate the protobuf source code.

sbt compile

Because depending on the Scala version, there are projects that are disabled (No spark3 for Scala 2.11) and differentlibraries dependencies. Because this, there is a flag called PATCH_211 (default value is false) to enable or disableScala 2.11 compatibility.

The project is using cross version to manage 2.11, 2.12 and 2.13 using the same code base, so remember to use '+' totrigger all versions versions.

So remember, as example, for testing:

PATCH_211=false sbt +testPATCH_211=true sbt +test

The publication into Maven Central has been removed from the release process, so now there are few steps:

1. Release.

   git checkout mastersbt release

2. Publish into Maven Central. Information about configuration in plugins involved:

   • sbt-pgp usinggpg command-line utility under the cover.
   • Sonatype GPG documentation
   • xerial/sbt-sonatype
   • scala-lang documentation

   Basically:

   • Set the keys assbt-pgp#working-with-pgp-signatures explains.
   • Be sure that public key has been uploaded into, at least last time,pgp.mit.edu:gpg --keyserver hkp://pgp.mit.edu --send-keys <key>
   • Set the right credentials file at$HOME/.sbt/1.0/sonatype.sbt.
   • Execute:

   git checkout v1.*.*sbt cleanPATCH_211=false sbt +publishSignedPATCH_211=true sbt +publishSigned# In this point, tree target/sonatype-staging/ will show all artifacts to publish.sbt sonatypeBundleRelease

3. Publish documentation and site.

   git checkout v1.*.*cd websitenvm useexport GIT_USER=<username>;export USE_SSH=true; npm run deploy

• PBF2 Documentation:http://wiki.openstreetmap.org/wiki/PBF_Format
• PBF2 Java library:https://github.com/openstreetmap/osmosis/tree/master/osmosis-osm-binary
• Download whole planet pbf files:http://free.nchc.org.tw/osm.planet/
• Download country pbf files:http://download.geofabrik.de/index.html
• Scala protocol buffer library:https://scalapb.github.io/ andhttps://github.com/thesamet/sbt-protoc
• OSM primitives:https://wiki.openstreetmap.org/wiki/Elements
  • Node:https://wiki.openstreetmap.org/wiki/Node
  • Way:https://wiki.openstreetmap.org/wiki/Way
  • Relations:https://wiki.openstreetmap.org/wiki/Relation
  • Tags:https://wiki.openstreetmap.org/wiki/Tags

• ScalaPB:https://scalapb.github.io/ andhttps://github.com/thesamet/sbt-protoc