diff --git a/docs/downloads/alternative-model/cfhb.md b/docs/downloads/alternative-model/cfhb.md index 168be58..db13233 100644 --- a/docs/downloads/alternative-model/cfhb.md +++ b/docs/downloads/alternative-model/cfhb.md @@ -6,7 +6,7 @@ sidebar_position: 1 # CfHbKeyValue -Information about the sources from which the record has been collected +Information about the sources from which the record has been collected. @JsonSchema(description = "the OpenAIRE identifier of the data source") @@ -22,7 +22,7 @@ the OpenAIRE identifier of the data source ### value _Type: String • Cardinality: ONE_ -The name of the data source +The name of the data source. ```json "value":"Crossref" diff --git a/docs/downloads/alternative-model/context.md b/docs/downloads/alternative-model/context.md index 0b50ca3..2684d85 100644 --- a/docs/downloads/alternative-model/context.md +++ b/docs/downloads/alternative-model/context.md @@ -6,7 +6,7 @@ sidebar_position: 1 # Context -Information related to research initiative/community (RI/RC) related to the result +Information related to research initiative/community (RI/RC) related to the result. ### code _Type: String • Cardinality: ONE_ @@ -22,7 +22,7 @@ Code identifying the RI/RC. ### label _Type: String • Cardinality: ONE_ -Label of the RI/RC +Label of the RI/RC. ```json "label":"SDSN - Greece" diff --git a/docs/downloads/alternative-model/extendedresult.md b/docs/downloads/alternative-model/extendedresult.md index 2e90acc..d9e9b0c 100644 --- a/docs/downloads/alternative-model/extendedresult.md +++ b/docs/downloads/alternative-model/extendedresult.md @@ -17,7 +17,7 @@ It is a subclass of [Result](../../../data-model/entities/result) extended with _Type: [Project](project.md) • Cardinality: MANY_ -List of projects (i.e. grants) that (co-)funded the production of the research results +List of projects (i.e. grants) that (co-)funded the production of the research results. ```json @@ -54,7 +54,7 @@ List of projects (i.e. grants) that (co-)funded the production of the research r _Type: [Context](./context) • Cardinality: MANY_ -Reference to relevant research infrastructure, initiative or communities (RI/RC) among those collaborating with OpenAIRE. Please see https://connect.openaire.eu" that are publicly visible +Reference to relevant research infrastructure, initiative or communities (RI/RC) among those collaborating with OpenAIRE. Please see https://connect.openaire.eu that are publicly visible. ```json @@ -83,7 +83,7 @@ Reference to relevant research infrastructure, initiative or communities (RI/RC) _Type: [CfHbKeyValue](./cfhb) • Cardinality: MANY_ -Information about the sources from which the record has been collected +Information about the sources from which the record has been collected. ```json @@ -139,5 +139,3 @@ Information about the source from which the instance can be viewed or downloaded ``` - - diff --git a/docs/downloads/alternative-model/funder.md b/docs/downloads/alternative-model/funder.md index 49671c3..1da93a9 100644 --- a/docs/downloads/alternative-model/funder.md +++ b/docs/downloads/alternative-model/funder.md @@ -7,7 +7,7 @@ sidebar_position: 1 # Funder -Information about the funder funding the project +Information about the funder funding the project. ### fundingStream diff --git a/docs/downloads/alternative-model/project.md b/docs/downloads/alternative-model/project.md index b0bae91..774b487 100644 --- a/docs/downloads/alternative-model/project.md +++ b/docs/downloads/alternative-model/project.md @@ -9,7 +9,7 @@ sidebar_position: 1 # Project -The information about the projects related to the result +The information about the projects related to the result. ### id @@ -77,7 +77,7 @@ Project's title. _Type [Funder](funder.md) • Cardinality: ONE_ -Information about the funder funding the project +Information about the funder funding the project. ```json @@ -99,7 +99,7 @@ Information about the funder funding the project _Type [Provenance](../../data-model/entities/other#provenance-2) • Cardinality: ONE_ -The reason why the project is associated to the result +The reason why the project is associated to the result. ```json @@ -119,7 +119,7 @@ The reason why the project is associated to the result _Type [Validated](validated.md) • Cardinality: ONE_ -Specifies it the association between the project and the result was validated +Specifies it the association between the project and the result was validated. ```json diff --git a/docs/downloads/alternative-model/validated.md b/docs/downloads/alternative-model/validated.md index b6be470..e92b2c9 100644 --- a/docs/downloads/alternative-model/validated.md +++ b/docs/downloads/alternative-model/validated.md @@ -7,7 +7,7 @@ sidebar_position: 1 # Validated -Information about the validtion of the association between the result and the funding information +Information about the validtion of the association between the result and the funding information. ### validationDate @@ -15,7 +15,7 @@ Information about the validtion of the association between the result and the fu _Type: String • Cardinality: ONE_ -When OpenAIRE collected the association between the funding and the result from an authoritative source (i.e. Sygma) +When OpenAIRE collected the association between the funding and the result from an authoritative source (i.e. Sygma). ```json @@ -30,7 +30,7 @@ When OpenAIRE collected the association between the funding and the result from _Type: Boolean • Cardinality: ONE_ -Specifies if the validation comes from the funder +Specifies if the validation comes from the funder. ```json diff --git a/docs/downloads/alternativedump.md b/docs/downloads/alternativedump.md deleted file mode 100644 index b22f3b2..0000000 --- a/docs/downloads/alternativedump.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Dump of Research Communities/Infrastructure and products related to projects - -The dump for Research Communities/Infrastructure and products related to projects do not follow the model used to dump the whole graph. -The main differences are: - - * only research products are dumped (no relations, and entities different from results) - * the dumped results are extended with information that can be inferred in the whole dump namely: - * funding information if present - * associated research community/infrastructure - * associated data sources - -So we have just one entity which is the [extended result](alternative-model/extendedresult.md) \ No newline at end of file diff --git a/docs/downloads/beginners-kit.md b/docs/downloads/beginners-kit.md new file mode 100644 index 0000000..5bb8548 --- /dev/null +++ b/docs/downloads/beginners-kit.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 2 +--- + +# Beginners kit + diff --git a/docs/downloads/downloads.md b/docs/downloads/downloads.md deleted file mode 100644 index 1bdcdcb..0000000 --- a/docs/downloads/downloads.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Bulk downloads - -You can download the full OpenAIRE Research Dump as well as its schema from the following links: - - Dataset: https://doi.org/10.5281/zenodo.3516917 - - Schema: https://doi.org/10.5281/zenodo.4238938 - -The schema used to dump this dataset mirrors the one described in the [Data Model](../data-model) -This dataset is licensed under a Creative Commons Attribution 4.0 International License. -It is composed of several files so that you can download the parts you are interested into. The files are named after the entity they store (i.e. publication, dataset). Each file is at most 10GB and it is -a tar archive containing gz files, each with one json per line. - - -:::note Tip! - -For a visual and interactive overview of the JSON schema, we suggest to use a JSON schema viewer like [jsonschemaviewer](https://navneethg.github.io/jsonschemaviewer/) (you just need to copy the schema and then you can easily navigate through the nodes). - -::: - - -
-
- - -
-
diff --git a/docs/downloads/full-graph.md b/docs/downloads/full-graph.md new file mode 100644 index 0000000..1aa9131 --- /dev/null +++ b/docs/downloads/full-graph.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 1 +--- + +# Full graph dump + +You can download the full OpenAIRE Research Graph Dump as well as its schema from the following links: + + Dataset: https://doi.org/10.5281/zenodo.3516917 + + Schema: https://doi.org/10.5281/zenodo.4238938 + +The schema used to dump this dataset mirrors the one described in the [Data Model](../data-model). +This dataset is licensed under a Creative Commons Attribution 4.0 International License. +It is composed of several files so that you can download the parts you are interested into. The files are named after the entity they store (i.e. publication, dataset). Each file is at most 10GB and it is +a tar archive containing gz files, each with one json per line. + + +:::note Tip! + +For a visual and interactive overview of the JSON schema, we suggest to use a JSON schema viewer like [jsonschemaviewer](https://navneethg.github.io/jsonschemaviewer/) (you just need to copy the schema and then you can easily navigate through the nodes). + +::: diff --git a/docs/downloads/related-datasets.md b/docs/downloads/related-datasets.md new file mode 100644 index 0000000..93f112c --- /dev/null +++ b/docs/downloads/related-datasets.md @@ -0,0 +1,18 @@ +--- +sidebar_position: 4 +--- + +# Other related datasets + +In this page, we list other related datasets; please refer to their respective schema definitions for the data model they follow. + +## The dump of ScholeXplorer + + Dataset: https://doi.org/10.5281/zenodo.6338616 + + Schema (Scholix version 3): https://doi.org/10.5281/zenodo.1120275 + + Schema (Scholix version 4): https://doi.org/10.5281/zenodo.6351557 + +This dataset is licensed under a CC0 1.0 Universal (CC0 1.0) Public Domain Dedication. +The dataset contains the GZ-compressed dump of the Scholix links exposed by the OpenAIRE ScholeXplorer service. \ No newline at end of file diff --git a/docs/downloads/starter-kit.md b/docs/downloads/starter-kit.md deleted file mode 100644 index 8071d5d..0000000 --- a/docs/downloads/starter-kit.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Starter-kit - diff --git a/docs/downloads/subgraphs.md b/docs/downloads/subgraphs.md index 03fe641..59ae4da 100644 --- a/docs/downloads/subgraphs.md +++ b/docs/downloads/subgraphs.md @@ -1,11 +1,13 @@ --- -sidebar_position: 4 +sidebar_position: 3 --- -# Sub-graphs and other formats +# Sub-graph dumps + +In order to facilitate users, different dumps are available under the Zenodo community called [OpenAIRE Research Graph](https://zenodo.org/communities/openaire-research-graph). +This page lists all alternative dumps currently available. + -In order to facilitate users, different dumps and formats are available under the Zenodo community called [OpenAIRE Research Graph](https://zenodo.org/communities/openaire-research-graph). -In the following, you can find the list of alternative Dumps currently available: ## The OpenAIRE COVID-19 dump @@ -16,8 +18,7 @@ In the following, you can find the list of alternative Dumps currently available This dataset is licensed under a Creative Commons Attribution 4.0 International License. It contains metadata records of publications, research data, software and projects on the topic of Corona Virus and COVID-19. This dump is part of the activities of OpenAIRE to support the fight against COVID-19 together with the OpenAIRE COVID-19 Gateway. -The dump consists of a tar archive containing gzip files with one json per line. The model of this dump differs from the one of the whole graph. -The differences are shown in the [Alternative Model Dump](./alternativedump) +The dump consists of a tar archive containing gzip files with one json per line. Please refer [here](#alternative-sub-graph-data-model) for the data model of this dump. ## The dump of funded products @@ -29,7 +30,7 @@ The differences are shown in the [Alternative Model Dump](./alternativedump) It contains metadata records of research products (research literature, data, software, other types of research products) with funding information available in the OpenAIRE Graph. Records are grouped by funder in a dedicated archive file. Each tar archive contains gzip files, each with one json record per line. The model of this dump differs from the one of the whole graph. - The differences are shown in the [Alternative Model Dump](./alternativedump) +Please refer [here](#alternative-sub-graph-data-model) for the data model of this dump. ## The dump of delta projects @@ -51,16 +52,18 @@ gzip files, each with one json record per line. The model of this dump differs f The dataset contains one file per community/initiative/infrastructure collaborating with OpenAIRE. Check out also their community gateways on CONNECT. Each file is a tar archive containing gzip files with one json per line. The only communities/research initiative/infrastructure we dump are those visible to everyone. The model of this dump differs from the one of the whole graph. - The differences are shown in the [Alternative Model Dump](./alternativedump) +Please refer [here](#alternative-sub-graph-data-model) for the data model of this dump. -## The dump of ScholeXplorer + --- - Dataset: https://doi.org/10.5281/zenodo.6338616 - - Schema (Scholix version 3): https://doi.org/10.5281/zenodo.1120275 - - Schema (Scholix version 4): https://doi.org/10.5281/zenodo.6351557 + ## Alternative sub-graph data model - This dataset is licensed under a CC0 1.0 Universal (CC0 1.0) Public Domain Dedication. -The dataset contains the GZ-compressed dump of the Scholix links exposed by the OpenAIRE ScholeXplorer service. - + It should be noted that the dumps for research communities, infrastructures, and products related to projects do not strictly follow the main data model of the OpenAIRE Graph. In particular, they differ in the following: + + * only research products are dumped (no relations, and entities different from results) + * the dumped results are extended with information that can be inferred in the whole dump namely: + * funding information if present + * associated research community/infrastructure + * associated data sources + +So they have just one entity type, that is the [Extended Result](alternative-model/extendedresult.md). diff --git a/sidebars.js b/sidebars.js index 4ac07e2..aadca39 100644 --- a/sidebars.js +++ b/sidebars.js @@ -51,14 +51,19 @@ const sidebars = { href: "https://graph.openaire.eu/develop/overview.html" }, { - type: 'category', - label: 'Bulk downloads', - link: {type: 'doc', id: 'downloads/downloads'}, - items: [ - { type: 'doc', id: 'downloads/starter-kit' }, - { type: 'doc', id: 'downloads/subgraphs' }, - ] - }, + type: 'category', + label: "Downloads", + link: { + type: 'generated-index', + description: 'All resources, available for download, are listed below.' + }, + items: [ + { type: 'doc', id: 'downloads/full-graph'}, + { type: 'doc', id: 'downloads/beginners-kit' }, + { type: 'doc', id: 'downloads/subgraphs' }, + { type: 'doc', id: 'downloads/related-datasets' }, + ] + }, { type: 'category', label: "Data provision",