Import/Plan Outline

From OpenStreetMap Wiki
Jump to navigation Jump to search

This Import Plan Outline is intended to help ensure that your "Import plan" document covers as many of the common questions about imports as possible. Just create your own page and copy and paste the wiki text from here (starting from below the line)

Please! If you identify ways that this outline didn't meet the needs of your import (key evidence of this: tons of questions or alarm bells on the discussion!), please return and fix this page.


(Import title) is an import of (name of dataset) dataset which is of type (data type) covering (broad location in country). The import is currently (as of (date)) at the planning stage.

Goals

Identify the goals of the import.

Schedule

List the general timeframe of your project.

Import Data

Background

Provide links to your sources.

Data source site: http://website.tld
Data license: https://website.tld/license
Type of license (if applicable): List the license of the dataset. Use this format.
Link to permission (if required): Granted permission email, etc.
OSM attribution (if required): http://wiki.openstreetmap.org/wiki/Contributors#yourdataprovider
ODbL Compliance verified: yes/no

Note: if the data is released under a license that is already confirmed to be compatible with OpenStreetmap it may still be worth reaching out to the relevant contact to let them know their data was useful. Impact stories help to encourage continued investment and growth of open data programs.

OSM Data Files

Provide a link to the data files you have prepared for import.

Import Type

Identify if this is a one-time or recurring import and whether you'll be doing it with automated scripts, etc.

Identify what method will be used for entering the imported data into the OSM database - e.g. API, JOSM, MapRoulette, etc.

Data Preparation

Data Reduction & Simplification

Describe your plans, if any, to reduce the amount of data you'll need to import.

Examples of this include removing information that is already contained in OSM or simplifying shapefiles.

Tagging Plans

Describe your plan for mapping source attributes to OSM tags.

Changeset Tags

Fill in the values your changesets will use.

Key Value
comment
import yes
source name of the source dataset
source:url dataset link
source:date age of dataset at time of import, if known.
import:page link to this wiki page
source:license license of source dataset, using this format.

Data Transformation

Describe the transformations you'll need to conduct, the tools you're using, and any specific configurations or code that will be used in the transformation.

Data Transformation Results

Post a link to your OSM XML files.

Data Merge Workflow

Team Approach

Describe if you'll be doing this solo or as a team.

References

List all factors that will be evaluated in the import.

Workflow

Detail the steps you'll take during the actual import.

Information to include:

  • Step by step instructions
  • Changeset size policy
  • Revert plans

Conflation

Identify your approach to conflation here.

QA

Add your QA plan here.

See also

The post to the community forum was sent on YYYY-MM-DD and can be found here