Skip to content

Dataset: Add SPDX 3.1 (draft) for Example 01 #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bact wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Dataset: Add SPDX 3.1 (draft) for Example 01 #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fe66586
Dataset: Add SPDX 3.1 to Example 01
bact Apr 23, 2026
12adc15
Update specVersion: 3.1.0 -> 3.1
bact Apr 23, 2026
a73cbe3
Update property format
bact Apr 23, 2026
67efa55
Revise README for Dataset Example 01
bact Apr 23, 2026
7552146
Merge branch 'spdx:master' into dataset-ex01-spdx31-draft
bact Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions dataset/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ SPDX-FileType: DOCUMENTATION
SPDX-License-Identifier: CC-BY-4.0
---

# SPDX Dataset Profile Examples
# SPDX Dataset profile examples

This repository includes demonstrations of [SPDX documents](https://spdx.dev)
for a Dataset Profile.
Expand All @@ -12,13 +12,13 @@ for a Dataset Profile.

Directories of the form `example##` are structured as follows:

- `content/`: contains the example's content (data files, related source code,
etc.)
- `spdx3.0/`: contains one or more SPDX documents for the example
- `content/`: contains the example's content (data files, source code, etc.)
- `spdx3.0/`: contains SPDX 3.0 documents for the example
- `spdx3.1/`: contains SPDX 3.1 documents for the example
- `README.md`: more details about the particular example

## Examples

| ## | Data | Sources | SPDX | Comments |
|----|------|---------|------|----------|
| [01](./example01/) | 2 CSV files | - | 1 document | An example of a simple dataset in tabular format. |
| # | Data | Sources | SPDX 3.0 | SPDX 3.1 | Focus |
| - | ---- | ------- | -------- | -------- | ----- |
| [01](./example01/) | 2 CSV files | - | 1 document | 1 document | Tabular CSV dataset; `/Dataset/datasetType: structured, timestamp`; **3.0→3.1**: `/Dataset/datasetSize` → `/Software/artifactSize`, `/Dataset/intendedUse` → `/Core/intendedUse` |
17 changes: 11 additions & 6 deletions dataset/example01/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ SPDX-FileType: DOCUMENTATION
SPDX-License-Identifier: CC-BY-4.0
---

# Example 01
# Dataset example 1 - Gas emissions dataset

## Description

Expand All @@ -30,9 +30,14 @@ Greenhouse Gas Emissions dataset. It is available in full, under Creative
Commons Attribution 4.0 International License, at
<https://github.com/owid/co2-data/>.

This simplified
[Unified Modeling Language (UML)](https://en.wikipedia.org/wiki/Unified_Modeling_Language)
class diagram illustrates Example 01. Long string values are truncated and the
spdxIds are shortened (by removing the UUID suffix), for brevity.
The SBOM uses `/Dataset/datasetSize` (~200 KB) and `/Dataset/intendedUse`, both
of which are deprecated in SPDX 3.1 in favour of `/Software/artifactSize` and `/Core/intendedUse` respectively.

[![A diagram of a bill of materials of Dataset Example 01](./spdx3.0/example01.png "A diagram of a bill of materials of Dataset Example 01")](./spdx3.0/example01.png)
## SPDX files

| Version | File |
| ------- | ---- |
| SPDX 3.0 | [spdx3.0/example01.spdx3.json](./spdx3.0/example01.spdx3.json) |
| SPDX 3.1 (draft) | [spdx3.1/example01.spdx3.json-draft](./spdx3.1/example01.spdx3.json-draft) |

[![A diagram of Dataset profile example 01 - Simple tabular dataset.](./example01.spdx3.png "A diagram of Dataset profile example 01 - Simple tabular dataset.")](./example01.spdx3.png)
52 changes: 26 additions & 26 deletions dataset/example01/spdx3.0/example01.spdx3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
"@id": "_:creationinfo",
"specVersion": "3.0.1",
"createdBy": [
"https://spdx.org/spdxdocs/Person1-1000e6a2-0229-4875-baa7-c99be213b6e1"
"https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#Person1"
],
"created": "2024-05-31T00:00:00Z"
},
{
"type": "Person",
"spdxId": "https://spdx.org/spdxdocs/Person1-1000e6a2-0229-4875-baa7-c99be213b6e1",
"spdxId": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#Person1",
"creationInfo": "_:creationinfo",
"name": "Arthit Suriyawongkul",
"externalIdentifier": [
Expand All @@ -25,7 +25,7 @@
},
{
"type": "Organization",
"spdxId": "https://spdx.org/spdxdocs/Organization1-cb617656-1023-45e7-84c7-a9311644337b",
"spdxId": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#Organization1",
"creationInfo": "_:creationinfo",
"name": "Our World in Data",
"externalIdentifier": [
Expand All @@ -42,40 +42,40 @@
},
{
"type": "SpdxDocument",
"spdxId": "https://spdx.org/spdxdocs/Document1-a7a6f7a8-68d5-4052-b3f7-a005d6af28f1",
"spdxId": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002",
"creationInfo": "_:creationinfo",
"profileConformance": [
"core",
"dataset"
],
"rootElement": [
"https://spdx.org/spdxdocs/SBOM1-d44af211-2646-43bc-9058-f6aabd30f7ab"
"https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#SBOM1"
]
},
{
"type": "software_Sbom",
"spdxId": "https://spdx.org/spdxdocs/SBOM1-d44af211-2646-43bc-9058-f6aabd30f7ab",
"spdxId": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#SBOM1",
"creationInfo": "_:creationinfo",
"profileConformance": [
"core",
"dataset"
],
"rootElement": [
"https://spdx.org/spdxdocs/DatasetPackage1-035470d9-3ede-4952-91c8-c2abb943c90b"
"https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#DatasetPackage1"
],
"software_sbomType": [
"analyzed"
]
},
{
"type": "dataset_DatasetPackage",
"spdxId": "https://spdx.org/spdxdocs/DatasetPackage1-035470d9-3ede-4952-91c8-c2abb943c90b",
"spdxId": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#DatasetPackage1",
"creationInfo": "_:creationinfo",
"name": "Our World in Data CO2 and Greenhouse Gas Emissions dataset",
"originatedBy": [
"https://spdx.org/spdxdocs/Organization1-cb617656-1023-45e7-84c7-a9311644337b"
"https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#Organization1"
],
"suppliedBy": "https://spdx.org/spdxdocs/Organization1-cb617656-1023-45e7-84c7-a9311644337b",
"suppliedBy": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#Organization1",
"builtTime": "2023-12-16T11:22:38Z",
"releaseTime": "2024-04-15T08:10:00Z",
"software_packageVersion": "2024-04-15",
Expand All @@ -101,7 +101,7 @@
],
"dataset_datasetAvailability": "directDownload",
"dataset_dataCollectionProcess": "The data is collected from various sources, including international organizations and research institutions.",
"dataset_datasetSize": 2689,
"dataset_datasetSize": 204800,
"dataset_datasetType": [
"structured",
"timestamp"
Expand All @@ -116,69 +116,69 @@
},
{
"type": "software_File",
"spdxId": "https://spdx.org/spdxdocs/File1-d029fccb-7ee9-42be-a445-5e2066db0de8",
"spdxId": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#File1",
"creationInfo": "_:creationinfo",
"name": "data.csv",
"contentType": "text/csv;charset=UTF-8",
"software_primaryPurpose": "data",
"releaseTime": "2024-04-15T08:10:00Z",
"originatedBy": [
"https://spdx.org/spdxdocs/Organization1-cb617656-1023-45e7-84c7-a9311644337b"
"https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#Organization1"
]
},
{
"type": "software_File",
"spdxId": "https://spdx.org/spdxdocs/File2-caf55baf-cd02-406a-b7ec-838842ca869f",
"spdxId": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#File2",
"creationInfo": "_:creationinfo",
"name": "codebook.csv",
"contentType": "text/csv;charset=UTF-8",
"software_primaryPurpose": "data",
"releaseTime": "2024-04-15T08:10:00Z",
"originatedBy": [
"https://spdx.org/spdxdocs/Organization1-cb617656-1023-45e7-84c7-a9311644337b"
"https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#Organization1"
],
"description": "A description of each column in data.csv."
},
{
"type": "Relationship",
"spdxId": "https://spdx.org/spdxdocs/Relationship/contains-c64903fa-cab9-4880-8065-0b9b226ce009",
"spdxId": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#Relationship1",
"creationInfo": "_:creationinfo",
"relationshipType": "contains",
"from": "https://spdx.org/spdxdocs/DatasetPackage1-035470d9-3ede-4952-91c8-c2abb943c90b",
"from": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#DatasetPackage1",
"to": [
"https://spdx.org/spdxdocs/File1-d029fccb-7ee9-42be-a445-5e2066db0de8",
"https://spdx.org/spdxdocs/File2-caf55baf-cd02-406a-b7ec-838842ca869f"
"https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#File1",
"https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#File2"
],
"description": "DatasetPackage1 contains data.csv and codebook.csv."
},
{
"type": "Relationship",
"spdxId": "https://spdx.org/spdxdocs/Relationship/describes-de3f5855-bd5a-403f-9aa6-95dd97599c32",
"spdxId": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#Relationship2",
"creationInfo": "_:creationinfo",
"relationshipType": "describes",
"from": "https://spdx.org/spdxdocs/File2-caf55baf-cd02-406a-b7ec-838842ca869f",
"from": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#File2",
"to": [
"https://spdx.org/spdxdocs/File1-d029fccb-7ee9-42be-a445-5e2066db0de8"
"https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#File1"
],
"description": "codebook.csv describes data.csv."
},
{
"type": "Relationship",
"spdxId": "https://spdx.org/spdxdocs/Relationship/concludedLicense-8575546c-c4f7-41ec-bb8f-cbd66e70090a",
"spdxId": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#Relationship3",
"creationInfo": "_:creationinfo",
"relationshipType": "hasConcludedLicense",
"from": "https://spdx.org/spdxdocs/DatasetPackage1-035470d9-3ede-4952-91c8-c2abb943c90b",
"from": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#DatasetPackage1",
"to": [
"https://spdx.org/licenses/CC-BY-4.0"
],
"description": "DatasetPackage1 has a concluded license as CC-BY-4.0."
},
{
"type": "Relationship",
"spdxId": "https://spdx.org/spdxdocs/Relationship/declaredLicense-e5536c5e-c8b5-4d24-947f-674c27c0b6c1",
"spdxId": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#Relationship4",
"creationInfo": "_:creationinfo",
"relationshipType": "hasDeclaredLicense",
"from": "https://spdx.org/spdxdocs/DatasetPackage1-035470d9-3ede-4952-91c8-c2abb943c90b",
"from": "https://spdx.org/spdxdocs/dataset-example01-b1b2c3d4-e5f6-7890-abcd-000000001002#DatasetPackage1",
"to": [
"https://spdx.org/licenses/CC-BY-4.0"
],
Expand Down
Loading
Loading