Open Built Environment Datasets

OBED is a repository for datasets pertaining to the Architecture, Engineering, and Construction (AEC) and other built environment related industries.

1. Data packages must conform to the Frictionless Data Specification.
2. Data will be licensed as openly as possible, ideally under the Creative Commons Attribution-ShareAlike 4.0 International License.
3. CSV data is preferred, but not required.

Data Packages

A datapackage.json file will describe the data package as a whole, and describe one or more data resources.

If all the data is tabular (i.e. CSV files), then it will be described as a tabular data package with one or more tabular data resources each with a table schema and, if needed, a CSV dialect.

Each data package is stored in it's own directory:

|- data-package-name-1
   |- README.md
   |- datapackage.json
   |- data
      |- data.csv
      |- ...

It contains a:

• README.md to explain the provenance of the data
• datapackage.json a machine readable file that explains the structure and meaning of the data
• one or more data files, typically grouped in a data directory

The data package directory may also contain other files or sub-directories. These files may be scripts used to prepare the data package or other related resources.

Templates

A templates directory contains a template README.md and example datapackage.json snippets.

README.md template

In this repository, each data package must have a README.md. The README.md should follow good practices.

datapackage.json snippets

JSON snippets provide a fragment of a datapackage.json file to help you learn about that specific property or cut and paste into your own data package. E.g. licenses.json could include JSON for each recommended Open Definition conformant license.

Repository Structure

|
|- data-package-name-1
|   |- README.md
|   |- datapackage.json
|   |- data
|     |- data.csv
|     |- data.geojson
|     |- ...
|     
|- data-package-name-2
|  |- etc.
|
|- templates
|  |- README-template.md
|  |- licenses.json
|  |- contributors.json
|  |- dialect.json
|  |- ...
|
|- zip
|  |- data-package-name-1.zip
|  |- data-package-name-2.zip
|
|
|- goodtables.yaml
|- README.md   

Contributing

We value all types of contributions:

• documentation
• data packages
• issues and requests
• code

We thank the generous contributors to the Frictionless Data project.

To join them, please read CONTRIBUTING.md for details on our code of conduct and how to submit a pull request. Each contributed data package should be licensed as openly as possible.

Zipped Data Packages

With each commit to the repository, the data package directory is converted into a .zip file so it can be used with software that supports Frictionless Data such as the Data Curator app or the DataPackage.js library. The zip files are stored in the zip directory.

While the Frictionless Data approach to compressing data packages has not been finalised a number of Frictionless Data Software implementations support zip files.

To do: script needed

Licenses

Data Packages in this project are licensed as specified in each individual datapackage.json file. If a license is not specified, it is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License, and this is the preferred (but not required) license for all submitted data.

Credit

This work is based on the Frictionless Data Example Data Packages repository.