├── .github ├── pull_request_template.md └── workflows │ ├── publish.yaml │ └── test.yaml ├── .gitignore ├── CHANGELOG.md ├── CITATION.cff ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── Pipfile ├── README.md ├── best-practices └── README.md ├── core ├── README.md └── schema │ └── schema.yaml ├── geojson ├── README.md ├── datatypes.md ├── examples │ ├── featurecollection │ │ └── features.json │ └── individual-features │ │ ├── 12324.json │ │ ├── 2713.json │ │ └── collection.json └── schema │ └── datatypes.json ├── geoparquet ├── README.md ├── datatypes.md └── examples │ └── example.parquet ├── other └── datatypes.md └── process.md /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | **Related Issue(s):** # 2 | 3 | 4 | **Proposed Changes:** 5 | 6 | 1. ... 7 | 2. ... 8 | 9 | **PR Checklist:** 10 | 11 | - [ ] This PR has **no** breaking changes. 12 | - [ ] I have added my changes to the [CHANGELOG](https://github.com/fiboa/specification/blob/dev/CHANGELOG.md) 13 | **or** a CHANGELOG entry is not required. 14 | -------------------------------------------------------------------------------- /.github/workflows/publish.yaml: -------------------------------------------------------------------------------- 1 | name: Publish Schema 2 | on: 3 | release: 4 | types: 5 | - published 6 | jobs: 7 | deploy: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: inject env variables 11 | uses: rlespinasse/github-slug-action@v4 12 | - uses: actions/checkout@v4 13 | - name: copy content for publication 14 | run: | 15 | mkdir tmp 16 | cp -r core/schema/* tmp/ 17 | mkdir tmp/geojson 18 | cp -r geojson/schema/datatypes.json tmp/geojson/datatypes.json 19 | - name: deploy schemas for version ${{ env.GITHUB_REF_SLUG }} 20 | uses: peaceiris/actions-gh-pages@v3 21 | with: 22 | github_token: ${{ secrets.GITHUB_TOKEN }} 23 | publish_dir: tmp 24 | destination_dir: ${{ env.GITHUB_REF_SLUG }} 25 | -------------------------------------------------------------------------------- /.github/workflows/test.yaml: -------------------------------------------------------------------------------- 1 | name: Run Tests 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | deploy: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/setup-python@v5 10 | with: 11 | python-version: '>=3.9' 12 | - uses: actions/checkout@v4 13 | - name: Install pipenv 14 | run: | 15 | pip install pipenv 16 | pipenv install 17 | - run: pipenv run test-docs 18 | - run: pipenv run test-schema 19 | - run: pipenv run test-geojson-features 20 | - run: pipenv run test-geojson-collection 21 | - run: pipenv run test-geoparquet -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | geojson/schema/schema.json 2 | 3 | # OS files 4 | .DS_Store 5 | Thumbs.db 6 | 7 | # Editors 8 | /.idea/ 9 | /.vscode/ 10 | 11 | # Python 12 | Pipfile.lock 13 | __pycache__/ 14 | *.egg-info/ 15 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) 6 | and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). 7 | 8 | ## [Unreleased] 9 | 10 | ### Added 11 | 12 | - Property `category` 13 | - Property `determination_details` 14 | 15 | ### Changed 16 | 17 | - ... 18 | 19 | ### Deprecated 20 | 21 | - ... 22 | 23 | ### Removed 24 | 25 | - Value `administrative` was removed from `determination_method` in favour of the new property `category` 26 | 27 | ### Fixed 28 | 29 | - Various minor clarifications and editorial enhancements 30 | - GeoParquet encoding: Properties that are optional can be omitted if all values are null values 31 | - GeoJSON encoding: Clarify the encoding of the top-level properties (including `links` and `fiboa`) 32 | - GeoJSON encoding: Clarify the use of RFC 7946 33 | - GeoParquet encoding for bounding boxes and objects 34 | - Added descriptions to the allowed values for `determination_method` 35 | 36 | ## [v0.2.0] - 2024-04-10 37 | 38 | ### Added 39 | 40 | - `perimeter` property 41 | 42 | ### Changed 43 | 44 | - Migrate schemas to fiboa Schema 45 | - Collections don't need to be STAC Collections (but it's recommended) 46 | - Collections can be included in GeoJSON files 47 | - Collections can be linked to from the GeoJSON files 48 | 49 | ## [v0.1.0] - 2024-02-28 50 | 51 | ### Added 52 | 53 | - `collection` property 54 | - `determination_method` property 55 | - `determination_datetime` property 56 | 57 | ### Changed 58 | 59 | - Recommend snake_case instead of camcelCase 60 | - `area`: Changed datatype from uint8 to float 61 | 62 | ### Removed 63 | 64 | - Removed `expires` and `datetime` 65 | 66 | ### Fixed 67 | 68 | - Clarified that the id must be unique within the collection 69 | - Clarified `area` and restricted value range 70 | - Clarified the allowed schema formats 71 | 72 | ## [v0.0.2] - 2024-02-14 73 | 74 | - Use .yaml instead of .yml 75 | 76 | ## [v0.0.1] - 2024-02-14 77 | 78 | - First release 79 | 80 | [Unreleased]: 81 | [v0.2.0]: 82 | [v0.1.0]: 83 | [v0.0.2]: 84 | [v0.0.1]: 85 | -------------------------------------------------------------------------------- /CITATION.cff: -------------------------------------------------------------------------------- 1 | cff-version: 1.2.0 2 | message: "If you are referring to the fiboa specification in your publications, please cite it as below." 3 | type: software 4 | title: "Field Boundaries for Agriculture (fiboa) specification" 5 | authors: 6 | - name: fiboa contributors 7 | preferred-citation: 8 | type: standard 9 | title: "Field Boundaries for Agriculture (fiboa) specification" 10 | abstract: "Making field boundaries openly available in a unified way." 11 | version: 0.2.0 12 | year: 2024 13 | date-released: 2024-04-10 14 | license: Apache-2.0 15 | url: https://github.com/fiboa 16 | repository: https://github.com/fiboa/specification 17 | authors: 18 | - name: fiboa contributors 19 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, caste, color, religion, or sexual 10 | identity and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | - Demonstrating empathy and kindness toward other people 21 | - Being respectful of differing opinions, viewpoints, and experiences 22 | - Giving and gracefully accepting constructive feedback 23 | - Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | - Focusing on what is best not just for us as individuals, but for the overall 26 | community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | - The use of sexualized language or imagery, and sexual attention or advances of 31 | any kind 32 | - Trolling, insulting or derogatory comments, and personal or political attacks 33 | - Public or private harassment 34 | - Publishing others' private information, such as a physical or email address, 35 | without their explicit permission 36 | - Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | [Taylor Geospatial Engine](https://tgengine.org/connect/). 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series of 86 | actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or permanent 93 | ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within the 113 | community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.1, available at 119 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. 120 | 121 | Community Impact Guidelines were inspired by 122 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. 123 | 124 | For answers to common questions about this code of conduct, see the FAQ at 125 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at 126 | [https://www.contributor-covenant.org/translations][translations]. 127 | 128 | [homepage]: https://www.contributor-covenant.org 129 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html 130 | [Mozilla CoC]: https://github.com/mozilla/diversity 131 | [FAQ]: https://www.contributor-covenant.org/faq 132 | [translations]: https://www.contributor-covenant.org/translations 133 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Pull Requests are the primary method of contributing to the spec itself, 4 | and everyone is welcome to submit changes. 5 | If the changes can be done as an extension instead of modifying the core files 6 | then that route is recommended first, 7 | and once there is uptake for the extension it will be considered for core. 8 | 9 | We consider everyone using the specification to be a 'contributor', 10 | as fiboa is really about the end result of more interoperable data, 11 | not just creating a spec for the sake of it. 12 | So if you want to help then the best thing you can do is make new data set or 13 | build software that uses the spec. 14 | And please do give us feedback. 15 | 16 | ## Submitting Pull Requests 17 | 18 | Any proposed changes to the specification should be done as pull requests. 19 | Creating a Pull Request will show our PR template, 20 | which includes checkbox reminders for a number of things. 21 | 22 | - Adding an entry the [CHANGELOG](CHANGELOG.md). 23 | If the change is more editorial and minor then this is not required, 24 | but any change to the actual specification must have one. 25 | - Rebase the PR against `main`. 26 | - Highlight if the PR makes breaking changes to the specification. 27 | 28 | All pull requests should submit clean markdown, which is checked by the CI. 29 | Please use the commands mentioned below locally before submitting, 30 | to ensure that the checks on the pull request succeed. 31 | 32 | All pull requests additionally require a review of two project team members. 33 | Releases are cut from main, see the [process](process.md) document for more details. 34 | 35 | ## Check files 36 | 37 | You'll need to install Python >= 3.9 and pip to setup the test environment. 38 | We use pipenv to execute the tests. 39 | 40 | Start with the following command in the folder where this README is located: 41 | `pip install pipenv --user` 42 | 43 | Finally, you can run the tests as follows: 44 | 45 | - To check the markdown run: `pipenv run test-docs` 46 | - To check the fiboa schema run: `pipenv run test-schema` 47 | - To check the examples run: 48 | - `pipenv run test-geojson-collection` and `pipenv run test-geojson-features` for GeoJSON 49 | - `pipenv run test-geoparquet` for GeoParquet 50 | - To create a GeoParquet from the GeoJSON examples: `pipenv run create-geoparquet` 51 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Pipfile: -------------------------------------------------------------------------------- 1 | [[source]] 2 | url = "https://pypi.org/simple" 3 | verify_ssl = true 4 | name = "pypi" 5 | 6 | [packages] 7 | fiboa-cli = ">=0.4" 8 | pymarkdownlnt = ">=0.9" 9 | 10 | [scripts] 11 | test-docs = "pymarkdown -d md024,md013 scan ." 12 | test-schema = "fiboa validate-schema core/schema/schema.yaml" 13 | test-geojson-collection = "fiboa validate geojson/examples/featurecollection -s core/schema/schema.yaml --data" 14 | test-geojson-features = "fiboa validate geojson/examples/individual-features -s core/schema/schema.yaml --data" 15 | test-geoparquet = "fiboa validate geoparquet/examples -s core/schema/schema.yaml --data" 16 | create-geoparquet = "fiboa create-geoparquet geojson/examples/featurecollection/features.json -o geoparquet/examples/example.parquet -s core/schema/schema.yaml" 17 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Field Boundaries for Agriculture (fiboa) Specification 2 | 3 | The Field Boundaries for Agriculture (fiboa) project is focused on making field boundary data openly available in a unified format on a global scale. 4 | We believe that the fiboa specification is a foundational aspect of agricultural field boundary data interoperability 5 | which enables and accelerates additional layers of collaboration and detail via custom extensions. 6 | This repository contains the core specification for fiboa, including the data schema. 7 | For more context, information on the ecosystem, and points of contact see the 8 | [fiboa github organization](https://github.com/fiboa/). 9 | 10 | - Version: **0.2.0** 11 | 12 | > [!IMPORTANT] 13 | > The fiboa specification is a work in progress. 14 | > Feedback is welcome and encouraged. 15 | > You can follow our [CHANGELOG](https://github.com/fiboa/specification/blob/main/CHANGELOG.md) to track our progress. 16 | 17 | ## Key Features 18 | 19 | The center of fiboa is the specification for representing field boundary data in GeoJSON & GeoParquet in a standard way, 20 | with several optional extensions that specify additional attributes. 21 | The core data schema of fiboa is quite simple: it’s a set of definitions for attribute names and values. 22 | The number of attributes in the core is quite small by design. 23 | The idea is that most of the ‘interesting’ data about the field will be located in extensions. 24 | 25 | The specification in this repository consists of three parts: 26 | 27 | - [Core Specification](core/README.md) 28 | (file format agnostic definition for data and metadata) 29 | - [GeoJSON Encoding](geojson/README.md) 30 | - [GeoParquet Encoding](geoparquet/README.md) 31 | 32 | To completent the specification, there are also best practices and extensions available: 33 | 34 | - [Best Practices](best-practices/README.md) 35 | - [Extensions](https://github.com/fiboa/extensions/) 36 | 37 | The repository also contains additional information about the project: 38 | 39 | - [Changelog](CHANGELOG.md) 40 | - [Citation Details (as CFF file)](CITATION.cff) 41 | 42 | The fiboa community strives to provide a welcoming and transparent environment for all of the project’s participants. 43 | You can find additional information about our community best practices and collaborative development processes below: 44 | 45 | - [Code of Conduct](CODE_OF_CONDUCT.md) 46 | - [Contribution Guideline](CONTRIBUTING.md) 47 | - [Development and Release Process](process.md) 48 | -------------------------------------------------------------------------------- /best-practices/README.md: -------------------------------------------------------------------------------- 1 | # Best Practices 2 | 3 | > [!NOTE] 4 | > We are in an early stage. More best practices will evolve over time. 5 | 6 | ## Casing 7 | 8 | All properties should be using snake case. 9 | For example a field for a land-use class should be named `landuse_class` instead of `landuseClass`. 10 | -------------------------------------------------------------------------------- /core/README.md: -------------------------------------------------------------------------------- 1 | # Core Specification 2 | 3 | This specification describes the core data and metadata properties for both at the 4 | Collection and Feature level. 5 | 6 | - A Collection refers to a group of one or more features. 7 | - A Feature is a single field geometry with additional properties. 8 | 9 | > [!NOTE] 10 | > The Core Specification is still work in progress. Feedback is welcome! 11 | 12 | - **Schema:** 13 | 14 | ## Schema 15 | 16 | The data types in the following document are defined in 17 | [fiboa Schema](https://github.com/fiboa/schema), v0.1.0. 18 | 19 | fiboa Schema defines a (limited) set of data types and a vocabulary to express 20 | additional constraints for these data types. 21 | This allows to define a clear mapping between the core specification and its encodings. 22 | 23 | - [Data types](https://github.com/fiboa/schema/blob/v0.1.0/datatypes.md) 24 | - [Vocabulary](https://github.com/fiboa/schema/blob/v0.1.0/README.md#vocabulary) 25 | 26 | ## Collection 27 | 28 | Collection-level metadata must be provided in an object that contains the properties below. 29 | The invidiual encodings may decide to embed the collection or make it available separately. 30 | 31 | ### Properties 32 | 33 | | Property Name | Data Type | Description | 34 | | ---------------- | -------------- | ----------- | 35 | | fiboa_version | string | **REQUIRED.** Version number of the fiboa specification this entity implements. | 36 | | fiboa_extensions | array\ | A list of URIs to extensions this entity implements. | 37 | 38 | Generally, the version and the extensions must be uniform per Collection. 39 | 40 | Other properties are also allowed to be provided, but are not described by this specification. 41 | 42 | ## Features 43 | 44 | ### General Properties 45 | 46 | | Property Name | Data Type | Description | 47 | | ------------- | -------------- | ----------- | 48 | | id | string | **REQUIRED.** A unique identifier for the field. It must be unique within the [Collection](#collection). | 49 | | collection | string | The identifier of the parent collection. | 50 | | category | array\ | A set of categories the field boundary belongs to. | 51 | 52 | **collection:** The collection identifier is usually only needed for merged datasets. 53 | 54 | **category:** Choose any (unique) combination of the following values: 55 | 56 | - `conceptual`: This boundary represents how the grower thinks of a field, and what they would share with service 57 | providers to allocate information at the highest level of the field concept within their operation. 58 | - `operational`: This boundary represents a management area used for a specific set of field operations as 59 | defined by or for the grower and is shared with service providers for field operation execution, analysis, or recommendations. 60 | - `economic`: This boundary is used to define, plan, and analyze a field for business purposes as defined 61 | by or for the grower. Use examples would include greenhouse gas/sustainability/traceability programs, ownership/splits, and billing. 62 | - `administrative`: This boundary is used to organize data that is defined by some other authority and is generally 63 | not easy to change. Use examples include government programs, insurance, and legal land description. 64 | - `other`: Any other category of field boundaries. 65 | 66 | The categories are based on the [definitions of the AgGateway initiative](https://aggateway.org/Portals/1010/WebSite/About%20Us/FIELD%20BOUNDARY%20FLYER%20122123.pdf?ver=2024-01-03-212959-590). 67 | 68 | ### Spatial Properties 69 | 70 | | Property Name | Data Type | Description | 71 | | ------------- | ------------ | ----------- | 72 | | geometry | geometry | **REQUIRED.** A geometry that reflects the footprint of the field, usually a Polygon. Default CRS is WGS84. | 73 | | bbox | bounding-box | The bounding box of the field. | 74 | | area | float | Area of the field, in hectares. Must be > 0 and <= 100,000. | 75 | | perimeter | float | Perimeter of the field, in meters. Must be > 0 and <= 125,000. | 76 | 77 | **area/perimeter:** These are derived attributes from the geometry itself, 78 | and must match the geometry's area/perimeter. If they do not match then the 79 | geometry should be considered canonical. 80 | Validators may flag the value as invalid if it exceeds a certain threshold. 81 | 82 | ### Determination Properties 83 | 84 | | Property Name | Data Type | Description | 85 | | ---------------------- | --------- | ------------------------------------------------------------ | 86 | | determination_method | string | The boundary creation method, one of the values below. | 87 | | determination_datetime | datetime | The last timestamp at which the field did exist and was observed, in UTC. | 88 | | determination_details | string | Further details about the determination, especially the methodology. | 89 | 90 | **determination_datetime**: In case the source of the information is an 91 | interval or a set of timestamps, use the end. 92 | For example, for ML you'd use the timestamp of the last image and not the 93 | timestamp of the actual execution. 94 | 95 | > [!NOTE] 96 | > We define more temporal properties in the 97 | > [timestamps extension](https://github.com/fiboa/timestamps). 98 | 99 | **determination_method**: Must be one of the following values: 100 | 101 | - `manual`: Hand created from imagery, e.g. using a tool to point and click on a map. 102 | - `surveyed`: Determined through a professional land survey measuring the actual distances and angles on the ground. 103 | - `driven`: An operator physically drove (or walked) around the perimeter of the field with a geopositioning device (e.g. GPS) that records the path taken. The operator actively and explicitly selected in the terminal to create a boundary. 104 | - `auto-operation`: Automatically created from operation. Similar to driven but it is an implicit result of normal agricultural operations, so this is usually using the coverage map to determine the boundary. 105 | - `auto-imagery`: Automatically created from aerial or satellite imagery, e.g. using CV or ML techniques. 106 | - `unknown`: The default value. This often means it is defined by some other authority (see `category`) and is likely one of the other methods but there's no knowledge of which exactly. 107 | 108 | The determination methods are based on the definitions of the [AgGateway initiative - WG17](https://aggateway.org/). 109 | The specific values have [not been published yet](https://github.com/fiboa/specification/issues/31). 110 | -------------------------------------------------------------------------------- /core/schema/schema.yaml: -------------------------------------------------------------------------------- 1 | $schema: https://fiboa.github.io/schema/v0.1.0/schema.json 2 | required: 3 | - id 4 | - geometry 5 | properties: 6 | id: 7 | type: string 8 | minLength: 1 9 | collection: 10 | type: string 11 | minLength: 1 12 | category: 13 | type: array 14 | uniqueItems: true 15 | items: 16 | type: string 17 | enum: 18 | - conceptual 19 | - operational 20 | - economic 21 | - administrative 22 | - other 23 | geometry: 24 | type: geometry 25 | bbox: 26 | type: bounding-box 27 | area: 28 | type: float 29 | exclusiveMinimum: 0 30 | maximum: 100000 31 | perimeter: 32 | type: float 33 | exclusiveMinimum: 0 34 | maximum: 125000 35 | determination_datetime: 36 | type: date-time 37 | determination_method: 38 | type: string 39 | enum: 40 | - manual 41 | - driven 42 | - surveyed 43 | - auto-operation 44 | - auto-imagery 45 | - unknown 46 | determination_details: 47 | type: string 48 | -------------------------------------------------------------------------------- /geojson/README.md: -------------------------------------------------------------------------------- 1 | # GeoJSON Encoding Specification 2 | 3 | The GeoJSON encoding defines how field boundaries compliant to fiboa must be published. 4 | The generic GeoJSON format is defined in 5 | [IETF RFC 7946](https://datatracker.ietf.org/doc/html/rfc7946). 6 | 7 | > [!NOTE] 8 | > The GeoJSON encoding is still work in progress. Feedback is welcome! 9 | 10 | - **[Examples](examples/):** 11 | 1. [as a FeatureCollection](examples/featurecollection/features.json) 12 | 2. [as individual Features with a dedicated Collection](examples/individual-features/) 13 | - **[Datatype mapping](datatypes.md)** 14 | 15 | ## Collection 16 | 17 | A [fiboa Collection](../core/README.md#collection) must be provided as a JSON object, either 18 | 1. embedded into the GeoJSON in a top-level property named `fiboa` (see example 1), or 19 | 2. separately as a JSON file that is linked to from the GeoJSON (see example 2). 20 | 21 | A fiboa Collection may be a [GeoJSON FeatureCollection](https://datatracker.ietf.org/doc/html/rfc7946#section-3.3). 22 | All features in a FeatureCollection must be fiboa-compliant. 23 | 24 | ## Features 25 | 26 | Each [fiboa Feature](../core/README.md#features) must be a valid 27 | [GeoJSON Feature](https://datatracker.ietf.org/doc/html/rfc7946#section-3.2). 28 | 29 | The following properties are defined for a GeoJSON Feature (at the top-level of the object): 30 | 31 | | Property Name | Data Type | Description | 32 | | ------------- | ------------------- | ------------------------------------------------------------ | 33 | | id | string | **REQUIRED. ** See [id](../core/README.md#general-properties) in the core specification, must not be a `number` | 34 | | type | string | **REQUIRED. ** The GeoJSON type, must be: `Feature` | 35 | | geometry | object | **REQUIRED.** A [GeoJSON Geometry Object](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1), must not be `null` | 36 | | bbox | array\ | A [GeoJSON Bounding Box](https://datatracker.ietf.org/doc/html/rfc7946#section-5) | 37 | | properties | object | An object with additional properties (see [`properties`](#properties)) | 38 | | links | array\ | A list of links (see [`links`](#links)) | 39 | | fiboa | object | An object with the [fiboa Collection](../core/README.md#collection) properties if not provided as a link (see [Collection](#collection)). | 40 | 41 | > [!IMPORTANT] 42 | > RFC 7946 doesn't support a property named `crs`, which was only available in an earlier version of GeoJSON (2008). 43 | > The CRS of the GeoJSON geometry and bbox must be WGS 84 / OGC CRS 84, 44 | > see the [RFC 7946, chapter 4](https://datatracker.ietf.org/doc/html/rfc7946#section-4) for details. 45 | 46 | ### `properties` 47 | 48 | Must include any property that is required by the fiboa core specification (currently none). 49 | May include any additional property. 50 | All properties defined by the core specification (except for `id`, `geometry` and `bbox`) or extensions should be provided here. 51 | 52 | ### `links` 53 | 54 | An array of links where each link conforms to the 55 | [Hyperlink Schema](http://schemas.opengis.net/ogcapi/common/part1/1.0/openapi/schemas/link.yaml) 56 | defined in 57 | [OGC API - Common - Part 1](https://docs.ogc.org/is/19-072/19-072.html#_11b9b4f7-42fc-413a-b63a-e7fb060b5e4b). 58 | 59 | The following relation types are commonly used: 60 | 61 | - `self`: Absolute link to the GeoJSON file itself. 62 | - `collection`: Link to the [Collection](#collection) 63 | -------------------------------------------------------------------------------- /geojson/datatypes.md: -------------------------------------------------------------------------------- 1 | # Mapping of fiboa Data Types to GeoJSON 2 | 3 | The following table shows the data types that are used by fiboa in the Property definitions. 4 | It also shows the mapping to the GeoJSON data types. 5 | 6 | | fiboa data type | (Geo)JSON | 7 | | --------------------------------------------------- | ------------------------------------------------------------ | 8 | | boolean | boolean | 9 | | int8 | integer
minimum: -128
maximum: 127 | 10 | | uint8 | integer
minimum: 0
maximum: 255 | 11 | | int16 | integer
minimum: -32768
maximum: 32767 | 12 | | uint16 | integer
minimum: 0
maximum: 65535 | 13 | | int32 | integer
minimum: -2147483648
maximum: 2147483647 | 14 | | uint32 | integer
minimum: 0
maximum: 4294967295 | 15 | | int64 | integer
minimum: -9223372036854775808
maximum: 9223372036854775807 | 16 | | uint64 | integer
minimum: 0
maximum: 18446744073709551615 | 17 | | float
IEEE 32-bit | number
minimum: ?
maximum: ? | 18 | | double
IEEE 64-bit | number
minimum: ?
maximum: ? | 19 | | binary | string
contentEncoding: binary | 20 | | string
charset: UTF-8 | string | 21 | | array | array | 22 | | object
keys: string
values: any | object
additionalProperties: false | 23 | | date | string
format: date | 24 | | date-time
with milliseconds
timezone: UTC | string
format: date-time
pattern: Z$ | 25 | | geometry | [object with schema](https://geojson.org/schema/Geometry.json) | 26 | | bounding-box
x and y only, no z | array
minItems: 4
maxItems: 4
items: number | 27 | | *required* (not a datatype) | null | 28 | 29 | ## Potential issues in conversion 30 | 31 | - NaN and +/-Infinity can't be encoded in JSON 32 | -------------------------------------------------------------------------------- /geojson/examples/featurecollection/features.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "FeatureCollection", 3 | "features": [ 4 | { 5 | "id": "12324", 6 | "type": "Feature", 7 | "properties": { 8 | "inspire:id": "https://geodaten.nrw.de/id/inspire-lc-fb/landcoverunit/12324", 9 | "flik": "DENWLI0542130247", 10 | "determination_datetime": "2005-02-28T00:00:00Z", 11 | "nutz_code": "A", 12 | "nutz_txt": "Ackerland", 13 | "area": 1.631100058555603 14 | }, 15 | "geometry": { 16 | "type": "Polygon", 17 | "coordinates": [ 18 | [ 19 | [ 20 | 7.875243329949302, 21 | 51.7469574917968 22 | ], 23 | [ 24 | 7.8754156210171224, 25 | 51.74865579902567 26 | ], 27 | [ 28 | 7.87559517961007, 29 | 51.748657516128716 30 | ], 31 | [ 32 | 7.875727139469757, 33 | 51.74864762337336 34 | ], 35 | [ 36 | 7.875865723118926, 37 | 51.74861179149097 38 | ], 39 | [ 40 | 7.876160946694515, 41 | 51.74853656922356 42 | ], 43 | [ 44 | 7.876274940061089, 45 | 51.748526513043004 46 | ], 47 | [ 48 | 7.876646213349393, 49 | 51.74852263605798 50 | ], 51 | [ 52 | 7.876669177898854, 53 | 51.74759587524452 54 | ], 55 | [ 56 | 7.876683221091441, 57 | 51.7470291214554 58 | ], 59 | [ 60 | 7.875243329949302, 61 | 51.7469574917968 62 | ] 63 | ] 64 | ] 65 | }, 66 | "bbox": [ 67 | 7.875243329949302, 68 | 51.7469574917968, 69 | 7.876683221091441, 70 | 51.748657516128716 71 | ] 72 | }, 73 | { 74 | "id": "2713", 75 | "type": "Feature", 76 | "properties": { 77 | "inspire:id": "https://geodaten.nrw.de/id/inspire-lc-fb/landcoverunit/2713", 78 | "flik": "DENWLI0540210084", 79 | "determination_datetime": "2005-02-28T00:00:00Z", 80 | "nutz_code": "A", 81 | "nutz_txt": "Ackerland", 82 | "area": 1.8975000381469727 83 | }, 84 | "geometry": { 85 | "type": "Polygon", 86 | "coordinates": [ 87 | [ 88 | [ 89 | 9.279072225112648, 90 | 51.925508828714925 91 | ], 92 | [ 93 | 9.279848170539884, 94 | 51.92582918268683 95 | ], 96 | [ 97 | 9.280173032315249, 98 | 51.925963048968214 99 | ], 100 | [ 101 | 9.280599939130775, 102 | 51.92614034991495 103 | ], 104 | [ 105 | 9.280660193987938, 106 | 51.926028714865886 107 | ], 108 | [ 109 | 9.280886077078973, 110 | 51.9256102896548 111 | ], 112 | [ 113 | 9.281335286046785, 114 | 51.924778127406576 115 | ], 116 | [ 117 | 9.281305739341624, 118 | 51.92472580957354 119 | ], 120 | [ 121 | 9.280917027691007, 122 | 51.92458295033388 123 | ], 124 | [ 125 | 9.279903540966059, 126 | 51.92421337118715 127 | ], 128 | [ 129 | 9.279817610187122, 130 | 51.92423316888092 131 | ], 132 | [ 133 | 9.279398358118248, 134 | 51.92501015234708 135 | ], 136 | [ 137 | 9.279241344298002, 138 | 51.925301083950984 139 | ], 140 | [ 141 | 9.279072225112648, 142 | 51.925508828714925 143 | ] 144 | ] 145 | ] 146 | }, 147 | "bbox": [ 148 | 9.279072225112648, 149 | 51.92421337118715, 150 | 9.281335286046785, 151 | 51.92614034991495 152 | ] 153 | } 154 | ], 155 | "fiboa": { 156 | "fiboa_version": "0.2.0", 157 | "fiboa_extensions": [ 158 | "https://fiboa.github.io/inspire-extension/v0.2.0/schema.yaml" 159 | ], 160 | "id": "de_nrw", 161 | "title": "Field boundaries for North Rhine-Westphalia (NRW), Germany", 162 | "license": "dl-de/by-2-0", 163 | "attribution": "Land Nordrhein-Westfalen / Open.NRW - https://www.opengeodata.nrw.de/produkte/umwelt_klima/bodennutzung/landwirtschaft/" 164 | } 165 | } -------------------------------------------------------------------------------- /geojson/examples/individual-features/12324.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "12324", 3 | "type": "Feature", 4 | "properties": { 5 | "flik": "DENWLI0542130247", 6 | "determination_datetime": "2005-02-28T00:00:00Z", 7 | "nutz_code": "A", 8 | "nutz_txt": "Ackerland", 9 | "area": 1.631100058555603 10 | }, 11 | "geometry": { 12 | "type": "Polygon", 13 | "coordinates": [ 14 | [ 15 | [ 16 | 7.875243329949302, 17 | 51.7469574917968 18 | ], 19 | [ 20 | 7.8754156210171224, 21 | 51.74865579902567 22 | ], 23 | [ 24 | 7.87559517961007, 25 | 51.748657516128716 26 | ], 27 | [ 28 | 7.875727139469757, 29 | 51.74864762337336 30 | ], 31 | [ 32 | 7.875865723118926, 33 | 51.74861179149097 34 | ], 35 | [ 36 | 7.876160946694515, 37 | 51.74853656922356 38 | ], 39 | [ 40 | 7.876274940061089, 41 | 51.748526513043004 42 | ], 43 | [ 44 | 7.876646213349393, 45 | 51.74852263605798 46 | ], 47 | [ 48 | 7.876669177898854, 49 | 51.74759587524452 50 | ], 51 | [ 52 | 7.876683221091441, 53 | 51.7470291214554 54 | ], 55 | [ 56 | 7.875243329949302, 57 | 51.7469574917968 58 | ] 59 | ] 60 | ] 61 | }, 62 | "links": [ 63 | { 64 | "href": "collection.json", 65 | "rel": "collection", 66 | "type": "application/json" 67 | } 68 | ] 69 | } -------------------------------------------------------------------------------- /geojson/examples/individual-features/2713.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "2713", 3 | "type": "Feature", 4 | "properties": { 5 | "flik": "DENWLI0540210084", 6 | "determination_datetime": "2005-02-28T00:00:00Z", 7 | "nutz_code": "A", 8 | "nutz_txt": "Ackerland", 9 | "area": 1.8975000381469727 10 | }, 11 | "geometry": { 12 | "type": "Polygon", 13 | "coordinates": [ 14 | [ 15 | [ 16 | 9.279072225112648, 17 | 51.925508828714925 18 | ], 19 | [ 20 | 9.279848170539884, 21 | 51.92582918268683 22 | ], 23 | [ 24 | 9.280173032315249, 25 | 51.925963048968214 26 | ], 27 | [ 28 | 9.280599939130775, 29 | 51.92614034991495 30 | ], 31 | [ 32 | 9.280660193987938, 33 | 51.926028714865886 34 | ], 35 | [ 36 | 9.280886077078973, 37 | 51.9256102896548 38 | ], 39 | [ 40 | 9.281335286046785, 41 | 51.924778127406576 42 | ], 43 | [ 44 | 9.281305739341624, 45 | 51.92472580957354 46 | ], 47 | [ 48 | 9.280917027691007, 49 | 51.92458295033388 50 | ], 51 | [ 52 | 9.279903540966059, 53 | 51.92421337118715 54 | ], 55 | [ 56 | 9.279817610187122, 57 | 51.92423316888092 58 | ], 59 | [ 60 | 9.279398358118248, 61 | 51.92501015234708 62 | ], 63 | [ 64 | 9.279241344298002, 65 | 51.925301083950984 66 | ], 67 | [ 68 | 9.279072225112648, 69 | 51.925508828714925 70 | ] 71 | ] 72 | ] 73 | }, 74 | "links": [ 75 | { 76 | "href": "collection.json", 77 | "rel": "collection", 78 | "type": "application/json" 79 | } 80 | ] 81 | } -------------------------------------------------------------------------------- /geojson/examples/individual-features/collection.json: -------------------------------------------------------------------------------- 1 | { 2 | "fiboa_version": "0.2.0", 3 | "fiboa_extensions": [], 4 | "stac_version": "1.0.0", 5 | "type": "Collection", 6 | "id": "de_nrw", 7 | "title": "Field boundaries for North Rhine-Westphalia (NRW), Germany", 8 | "description": "A field block (German: \"Feldblock\") is a contiguous agricultural area surrounded by permanent boundaries, which is cultivated by one or more farmers with one or more crops, is fully or partially set aside or is fully or partially taken out of production. Field blocks are classified separately according to the main land uses of arable land, grassland, permanent crops, 2nd pillar and other. Since 2005, field blocks in NRW have represented the area reference within the framework of the Integrated Administration and Control System (IACS) for EU agricultural subsidies.", 9 | "license": "proprietary", 10 | "providers": [ 11 | { 12 | "name": "Land Nordrhein-Westfalen / Open.NRW", 13 | "roles": [ 14 | "producer", 15 | "licensor" 16 | ], 17 | "url": "https://www.opengeodata.nrw.de/produkte/umwelt_klima/bodennutzung/landwirtschaft/" 18 | }, 19 | { 20 | "name": "fiboa CLI", 21 | "roles": [ 22 | "processor" 23 | ], 24 | "url": "https://pypi.org/project/fiboa-cli" 25 | }, 26 | { 27 | "name": "Source Cooperative", 28 | "roles": [ 29 | "host" 30 | ], 31 | "url": "https://beta.source.coop/fiboa/de-nrw/" 32 | } 33 | ], 34 | "extent": { 35 | "spatial": { 36 | "bbox": [ 37 | [ 38 | 5.8659988131, 39 | 50.3226989435, 40 | 9.4476584861, 41 | 52.5310351488 42 | ] 43 | ] 44 | }, 45 | "temporal": { 46 | "interval": [ 47 | [ 48 | "2005-02-28T00:00:00Z", 49 | "2024-03-28T00:00:00Z" 50 | ] 51 | ] 52 | } 53 | }, 54 | "links": [ 55 | { 56 | "href": "https://www.govdata.de/dl-de/by-2-0", 57 | "title": "Data licence Germany - attribution - Version 2.0", 58 | "type": "text/html", 59 | "rel": "license" 60 | } 61 | ] 62 | } -------------------------------------------------------------------------------- /geojson/schema/datatypes.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://json-schema.org/draft/2020-12/schema", 3 | "$id": "https://fiboa.github.io/specification/v0.2.0/geojson/datatypes.json", 4 | "$defs": { 5 | "boolean": { 6 | "type": "boolean" 7 | }, 8 | "int8": { 9 | "type": "integer", 10 | "minimum": -128, 11 | "maximum": 127 12 | }, 13 | "uint8": { 14 | "type": "integer", 15 | "minimum": 0, 16 | "maximum": 255 17 | }, 18 | "int16": { 19 | "type": "integer", 20 | "minimum": -32768, 21 | "maximum": 32767 22 | }, 23 | "uint16": { 24 | "type": "integer", 25 | "minimum": 0, 26 | "maximum": 65535 27 | }, 28 | "int32": { 29 | "type": "integer", 30 | "minimum": -2147483648, 31 | "maximum": 2147483647 32 | }, 33 | "uint32": { 34 | "type": "integer", 35 | "minimum": 0, 36 | "maximum": 4294967295 37 | }, 38 | "int64": { 39 | "type": "integer", 40 | "minimum": -9223372036854775808, 41 | "maximum": 9223372036854775807 42 | }, 43 | "uint64": { 44 | "type": "integer", 45 | "minimum": 0, 46 | "maximum": 18446744073709551615 47 | }, 48 | "float": { 49 | "type": "number", 50 | "minimum": 1.17549435e-38, 51 | "maximum": 3.4028235e38 52 | }, 53 | "double": { 54 | "type": "number", 55 | "minimum": 2.2250738585072014e-308, 56 | "maximum": 1.7976931348623157e308 57 | }, 58 | "binary": { 59 | "type": "string", 60 | "contentEncoding": "binary" 61 | }, 62 | "string": { 63 | "type": "string" 64 | }, 65 | "array": { 66 | "type": "array" 67 | }, 68 | "object": { 69 | "type": "object", 70 | "additionalProperties": false 71 | }, 72 | "date": { 73 | "type": "string", 74 | "format": "date" 75 | }, 76 | "date-time": { 77 | "type": "string", 78 | "format": "date-time", 79 | "pattern": "Z$" 80 | }, 81 | "geometry": { 82 | "$ref": "https://geojson.org/schema/Geometry.json" 83 | }, 84 | "bounding-box": { 85 | "type": "array", 86 | "minItems": 4, 87 | "maxItems": 4, 88 | "items": { 89 | "type": "number" 90 | } 91 | } 92 | } 93 | } -------------------------------------------------------------------------------- /geoparquet/README.md: -------------------------------------------------------------------------------- 1 | # GeoParquet Encoding Specification 2 | 3 | The Geoparquet encoding defines how field boundaries compliant to fiboa must be published. 4 | The generic GeoParquet format is defined in the 5 | [OGC GeoParquet specification v1.0.0](https://geoparquet.org/releases/v1.0.0/). 6 | We aim to support any future version of GeoParquet, too. 7 | 8 | > [!NOTE] 9 | > The GeoParquet encoding is still work in progress. Feedback is welcome! 10 | 11 | - **[Examples](examples/)** 12 | - **[Data type mapping](datatypes.md)** 13 | 14 | ## Collection 15 | 16 | The GeoParquet file must embed the [fiboa Collection](../core/README.md#collection) 17 | in the Parquet metadata in a property named `fiboa`. 18 | 19 | It is recommended to additionally provide the fiboa Collection as a separate JSON file, too. 20 | 21 | ## Features 22 | 23 | Each [fiboa Feature](../core/README.md#features) corresponds to a row in a GeoParquet file. 24 | 25 | The properties defined for fiboa Features are made available as individual columns in the GeoParquet file. 26 | 27 | Properties that are optional can be omitted if all values are 28 | [null values](https://parquet.apache.org/docs/file-format/nulls/), 29 | i.e. the column can be missing from the GeoParquet file. 30 | 31 | The mapping between the Parquet data types and the fiboa data types, can be found in the 32 | [data type mapping](datatypes.md). 33 | 34 | -------------------------------------------------------------------------------- /geoparquet/datatypes.md: -------------------------------------------------------------------------------- 1 | # Mapping of fiboa Data Types to GeoParquet 2 | 3 | The following table shows the data types that are used by fiboa in the Property definitions. 4 | It also shows the mapping to the GeoParquet data types. 5 | 6 | | fiboa Schema data type | (Geo)Parquet | 7 | | --------------------------------------------------- | ------------------------------------------------------------ | 8 | | boolean | BOOLEAN | 9 | | int8 | IntType
bitWidth: 8
isSigned: true
(deprecated: INT_8) | 10 | | uint8 | IntType
bitWidth: 8
isSigned: false
(deprecated: UINT_8) | 11 | | int16 | IntType
bitWidth: 16
isSigned: true
(deprecated: INT_16) | 12 | | uint16 | IntType
bitWidth: 16
isSigned: false
(deprecated: UINT_16) | 13 | | int32 | IntType
bitWidth: 32
isSigned: true
(deprecated: INT_32) | 14 | | uint32 | IntType
bitWidth: 64
isSigned: false
(deprecated: UINT_32) | 15 | | int64 | IntType
bitWidth: 64
isSigned: true
(deprecated: INT_64) | 16 | | uint64 | IntType
bitWidth: 64
isSigned: false
(deprecated: UINT_64) | 17 | | float
IEEE 32-bit | FLOAT | 18 | | double
IEEE 64-bit | DOUBLE | 19 | | binary | BYTE_ARRAY | 20 | | string
charset: UTF-8 | STRING (BYTE_ARRAY) | 21 | | array | LIST | 22 | | object
keys: string
values: any | STRUCT / MAP | 23 | | date | DATE (INT32) | 24 | | date-time
with milliseconds
timezone: UTC | TimestampType (INT64)
isAdjustedToUTC: true
unit: MILLIS
(deprecated: TIMESTAMP_MILLIS) | 25 | | geometry | BYTE_ARRAY
encoded as WKB | 26 | | bounding-box
x and y only, no z | STRUCT(xmin FLOAT, ymin FLOAT, xmax FLOAT, ymax FLOAT) | 27 | | *if a field is not required* | [Nullity](https://parquet.apache.org/docs/file-format/nulls/) | 28 | 29 | The integer data types and the data type string can also be mapped to the ENUM data type in Parquet 30 | if a pre-defined set of values is available. 31 | 32 | ## Unsupported Data Types 33 | 34 | The following data types occur in Parquet, but are not currently supported in fiboa: 35 | 36 | - FLOAT16 37 | - FIXED_LEN_BYTE_ARRAY 38 | - UUID (FIXED_LEN_BYTE_ARRAY) 39 | - TimeType (INT32) 40 | isAdjustedToUTC: true 41 | unit: MILLIS 42 | (deprecated: TIME_MILLIS) 43 | - Struct 44 | - JSON 45 | 46 | ## Potential issues in conversion 47 | 48 | - The micro/nanosecond precision of Datetime / Times may got lost 49 | -------------------------------------------------------------------------------- /geoparquet/examples/example.parquet: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fiboa/specification/1e11cadedb950c4d77f7402fd5f6f6a0e60e5d0d/geoparquet/examples/example.parquet -------------------------------------------------------------------------------- /other/datatypes.md: -------------------------------------------------------------------------------- 1 | # fiboa Data Types 2 | 3 | The following table shows the data types that are used by fiboa in the Property definitions. 4 | It explores the mapping to the corresponding data types in other file formats. 5 | 6 | | fiboa data type | FlatGeoBuf | Geopackage | Shapefile | 7 | | --------------------------------------------------- | ---------------------------------- | --------------- | -------------- | 8 | | boolean | Bool | BOOLEAN | - | 9 | | int8 | Byte | TINYINT | Short Integer? | 10 | | uint8 | UByte | SMALLINT? | Short Integer? | 11 | | int16 | Short | SMALLINT | Short Integer | 12 | | uint16 | UShort | MEDIUMINT? | Long Integer? | 13 | | int32 | Int | MEDIUMINT | Long Integer | 14 | | uint32 | UInt | INT? | - | 15 | | int64 | Long | INT | - | 16 | | uint64 | ULong | - | - | 17 | | float
IEEE 32-bit | Float | FLOAT (REAL) | Float | 18 | | double
IEEE 64-bit | Double | DOUBLE (REAL) | Double | 19 | | binary | Binary | BLOB | BLOB | 20 | | string
charset: UTF-8 | String | TEXT | Text | 21 | | array | Json? | - | - | 22 | | object
keys: string
values: any | Json? | - | - | 23 | | date | string? | DATE (TEXT) | Date | 24 | | date-time
with milliseconds
timezone: UTC | DateTime | DATETIME (TEXT) | Text? | 25 | | geometry | Binary
encoded as FlatBuffers | GEOMETRY (BLOB) | Geometry | 26 | | bounding-box
x and y only, no z | Json? | ? | ? | 27 | | *required* (not a datatype) | ? | NULL | - | 28 | 29 | ## Unsupported Data Types 30 | 31 | The following data types occur e.g. in Parquet, but are not currently supported in fiboa. 32 | 33 | | (Geo)Parquet | (Geo)JSON | FlatGeoBuf | Geopackage | Shapefile | 34 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ---------- | ---------- | --------- | 35 | | FLOAT16 | number
minimum: ?
maximum: ? | Float? | FLOAT? | Float? | 36 | | FIXED_LEN_BYTE_ARRAY | string
contentEncoding: binary
minLength and maxLength | Binary? | BLOB? | BLOB? | 37 | | UUID (FIXED_LEN_BYTE_ARRAY) | string
format: uuid | Binary? | BLOB? | ? | 38 | | TimeType (INT32)
isAdjustedToUTC: true
unit: MILLIS
(deprecated: TIME_MILLIS) | string
format: time
pattern: Z$ | ? | TEXT? | Text? | 39 | | Struct | object | Json? | - | - | 40 | | JSON | any | Json | - | - | 41 | 42 | Additionally, Shapefile has the big drawback that the field name limit is 10 characters. 43 | As such it doesn't work well with fiboa and its extension mechanism. 44 | 45 | ## Potential issues in conversion 46 | 47 | - The micro/nanosecond precision of Datetime / Times may got lost 48 | -------------------------------------------------------------------------------- /process.md: -------------------------------------------------------------------------------- 1 | # fiboa Development & Release Process 2 | 3 | ## Development Process 4 | 5 | The fiboa specification is under active development. The goal is to get to a 6 | small, flexible stable release that can be extended in a variety of ways. 7 | 8 | The [released versions](https://github.com/fiboa/specification/releases) 9 | aim to always be stable, meaning that all the pieces of the specification are 10 | consistent and well explained, and all the examples are consistent with the 11 | specification. 12 | The `main` branch is a place of active development, where a new change in one 13 | part of the spec might not yet be fully updated everywhere else. 14 | The team uses the [issue tracker](https://github.com/fiboa/specification/issues) 15 | to identify and track all that will be done for a release. 16 | 17 | Any changes to the spec must be proposed as pull requests. 18 | Anyone is welcome and encouraged to bring ideas and improvements to 19 | the issue tracker or (ideally) as pull requests. 20 | To merge a new pull request the work must be reviewed by at least two members of 21 | the past contributors that have write access to the repository. 22 | It also must pass the Continuous Integration (CI) testing, which checks 23 | all markdown and example files for proper formatting, 24 | and also validates all examples against the schemas. 25 | 26 | Check the [contributing guide](CONTRIBUTING.md) for more details. 27 | 28 | ## Release Process 29 | 30 | To release a new version of the fiboa specification 31 | the following list of tasks must be done. 32 | 33 | - **Update Issue Tracker**: 34 | Each release has a corresponding 35 | [milestone](https://github.com/fiboa/specification/milestones), 36 | and before a release is done all open issues that are filed against it should 37 | be reviewed. 38 | All issues do not need to be completed, but the core release team should all 39 | review the issues to make sure that the critical ones for the release have 40 | been addressed. 41 | Issues that aren't seen as essential should be moved to future releases, 42 | so that there are no open issues against the milestone. 43 | - **Agreement from the Project Team**: 44 | The project team should meet and decided that the release is ready. 45 | This should include review of the issues, as well as looking at the spec 46 | holistically, to make sure the new changes keep with a coherent whole. 47 | - **Final Spec Read Through**: 48 | There should be a final read through of the core specification to make sure 49 | it makes sense and there are no typos, errors, etc. 50 | - **Update the version numbers**: 51 | There are several places in the spec that use the version number in text or 52 | a link. These include the markdown files and the JSON schemas. 53 | Right now the best thing to do is just a search & replace for 54 | the last version number. 55 | - **Update the Changelog**: 56 | The [Changelog](CHANGELOG.md) should be reviewed to make sure it includes all 57 | major improvements in the release. And anything in 'Unreleased' section 58 | should move to the version of the spec to be released. 59 | - **Release on Github**: 60 | The final step to create the release is to add a new 'release' on 61 | . 62 | This should use a tag like the others, with a 'v' prefix and then 63 | the release number, like v1.0.2. 64 | The changelog should be copied over to be the release notes, 65 | and then also include a link to the full milestone of everything closed 66 | in the issue tracker. 67 | - **Promote the release**: 68 | A blog post and social media posts should be composed and sent out to post / 69 | promote it. 70 | --------------------------------------------------------------------------------