Repository files navigation

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 theFrictionless Data Specification.
2. Data will be licensed as openly as possible, ideally under theCreative Commons Attribution-ShareAlike 4.0 International License.
3. CSV data is preferred, but not required.

Adatapackage.json file will describe thedata package as a whole, and describe one or moredata resources.

If all the data is tabular (i.e.CSV files), then it will be described as atabular data package with one or moretabular data resources each with atable schema and, if needed, aCSV 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 adata directory

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

A templates directory contains a templateREADME.md and exampledatapackage.json snippets.

In this repository, each data package must have aREADME.md. TheREADME.md should followgood practices.

JSON snippets provide a fragment of adatapackage.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 eachrecommended Open Definition conformant license.

||- 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

We value all types of contributions:

• documentation
• data packages
• issues andrequests
• code

We thank the generouscontributors to the Frictionless Data project.

To join them, please readCONTRIBUTING.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.

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

Whilethe Frictionless Data approach to compressing data packages has not been finalised a number ofFrictionless Data Software implementations support zip files.

To do: script needed

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

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