Skip to content
Snippets Groups Projects

Restructuring sections

Merged SPRENGER Julia, NEA/SCI/DB requested to merge dev_patch-1 into dev
Compare and
2 files
+ 15
17
Preferences
Compare changes
Files
2
+ 15
17
@@ -98,9 +98,9 @@ Neutron-induced nuclear reaction data (neutron data), charged-particle induced n
CINDA (Computer Index of Nuclear Reaction Data) is a project ingesting EXFOR data and creating a subset of EXFOR data in a different format. This project is updated automatically and once per year. The NDS archives release versions and provides the releases to the public.
## Realization in 2024
# Realization in 2024
### NRDC Framework and Governance in 2024
## NRDC Framework and Governance in 2024
This section describes the implementation of the NRDC framework and governance principles based on the technologies available in 2024. The NRDC follows the [FAIR principles](https://www.go-fair.org/fair-principles) for data management.
@@ -129,7 +129,7 @@ Regarding the governance principles defined above, this defines the role of the
3. Archive
a. Ensure a local backup of the central project repositories exists. For release versions of software or data collections preserve a copy of the released files on a backed-up system.
### EXFOR
## EXFOR
The EXFOR project utilizes persistent identifiers (PIDs) for reference tracking of publications, authors and contributors. Currently, this is implemented via DOI references for publications and datasets and ORCID references for persons. Correspondingly, also releases of the EXFOR data collection will be attached to a DOI for persistent referencing.
@@ -139,7 +139,7 @@ The license for EXFOR data publication is CC BY 4.0. For source code MIT is reco
The workflow for data contribution is GitHub/GitLab based and lined out in the following.
#### Dataset contribution workflow details
### Dataset contribution workflow details
![Datafile Workflow](./sources/images/Exfor_generation_vision-modernization_step1.png)
@@ -157,24 +157,19 @@ The workflow follows a standard GitHub/GitLab based contribution workflow and co
8. Maintainer approves Pull / Merge Request. This triggers the automatic file name assignment
9. Merge dataset file into main branch
## EXFOR publication workflow details
### EXFOR publication workflow details
Upon addition of a new dataset via the workflow described above, a second workflow for building and releasing the dataset collection as a single file (aka. `Main file`, historically also named `Master file`) is triggered. This workflow consists of two stages:
1. Build of the Main file
2. Release of the Main file on [Zenodo](https://zenodo.org), assigning a digital object identifier to the file
## Further references
- Reasons why the NRDC Protocol needs updating: [external document](https://iaeacloud-my.sharepoint.com/:w:/g/personal/s_okumura_iaea_org/ES7AzHWR2gFMhwmgxzjyRLoBC9FmadoNAwyMIjvgiGe-SQ?e=4%3AORu7zY&at=9)
# Dictionary Protocol
### Future perspectives
1. Fully Automated and Modular System
The EXFOR dictionary system will be fully automated, integrating with external data sources through modern APIs. This allows seamless updates from databases such as ROR (for research institutes), ISSN/DOI (for journals), IAEA resources (Accelerator/Research reactor databases), and authoritative SI unit conversion databases like NIST or BIPM. The system will use standardized, modular formats (e.g., JSON, XML) following established schemas such as DataCite Metadata Schema to ensure future compatibility and make it easy to switch or add data sources if necessary.
The EXFOR system will be fully automated, integrating with external data sources through modern APIs. This allows seamless updates from databases such as ROR (for research institutes), ISSN/DOI (for journals), IAEA resources (Accelerator/Research reactor databases), and authoritative SI unit conversion databases like NIST or BIPM. The system will use standardized, modular formats (e.g., JSON, XML) following established schemas such as DataCite Metadata Schema to ensure future compatibility and make it easy to switch or add data sources if necessary.
2. Integration with Multiple External Data Sources
The system will pull data from a variety of sources, such as ROR for institutional information, ISSN/DOI for journals, other IAEA resources (Accelerator/Research reactor databases) for geolocation data, and SI unit databases (e.g., NIST or BIPM) for unit conversions, and ORCID for athor identification. This comprehensive integration ensures accurate and up-to-date dictionary entries across all categories (institutions, journals, locations, units, and authors).
The system will pull data from a variety of sources, such as ROR for institutional information, ISSN/DOI for journals, other IAEA resources (Accelerator/Research reactor databases) for geolocation data, and SI unit databases (e.g., NIST or BIPM) for unit conversions, and ORCID for author identification. This comprehensive integration ensures accurate and up-to-date entries across all categories (institutions, journals, locations, units, and authors).
The flexible architecture allows for straightforward integration of new or updated sources, making the system highly adaptable and future-proof.
3. Human-Maintained Combinations of Observables and Conditions
While most of the system is automated, the combinations of experimental physical observables and their measurement conditions will be curated by humans to ensure accuracy and proper descriptions. Each combination will be accompanied by detailed descriptions for clarity.
@@ -182,12 +177,15 @@ Upon addition of a new dataset via the workflow described above, a second workfl
4. Automated Processes with Optional Human Oversight
While combinations of observables and experimental conditions will be manually maintained, other updates—such as institutional data, journal references, geographic locations, and unit conversions—will be fully automated. The system includes provisions for human intervention in special cases where manual validation or adjustments are required. By default, most entries and updates will be processed automatically.
5. Transition to Global Standards
The system will follow globally recognized standards for data formats (e.g., JSON, XML) following established schema such as DataCite Metadataba Schema. This approach minimizes the need for ongoing internal maintenance while providing reliable and up-to-date information.
The system will follow globally recognized standards for data formats (e.g., JSON, XML) following established schema such as DataCite Metadatata Schema. This approach minimizes the need for ongoing internal maintenance while providing reliable and up-to-date information.
6. Real-time Synchronization and Updates
All updates—whether for institutional data, journal information, geographic locations, or unit conversions—will be automatically synchronized in real-time with the connected databases. The system will continuously monitor for updates, ensuring all entries are current without any manual data uploads or interventions. Human oversight will only be required in rare, exceptional cases.
# Historic project documents
## EXFOR
### Historic project documents
Historic documents related to the EXFOR project like, NRDC protocols, memos and exchange files like dictionaries, prelim and trans files are version controlled and publicly available at the [NEA GitLab](https://git.oecd-nea.org/exfor/nrdc).
## Further references
- Reasons why the NRDC Protocol needs updating: [external document](https://iaeacloud-my.sharepoint.com/:w:/g/personal/s_okumura_iaea_org/ES7AzHWR2gFMhwmgxzjyRLoBC9FmadoNAwyMIjvgiGe-SQ?e=4%3AORu7zY&at=9)
- The NDS github space: [link](https://github.com/IAEA-NDS)