FIPD Integration

The integration of BISON and FIPD (Yacout et al., 2021) is implemented with supporting files available from FIPD already in a form BISON can directly use. Also, certain BISON classes require files from FIPD when used. Certain BISON assessment cases use the optional fipd-bison-integration-data submodule that contains these supporting files for convenience during assessment testing. If a user wishes to use this submodule for convenience, each user will need to follow the below steps to properly get the submodule fipd-bison-integration-data. The submodule only includes required support files of FIPD data needed by BISON assessments. The most up-to-date data is found through FIPD and not through the fipd-bison-integration-data submodule, which requires manual updating of changes to data.

The optional fipd-bison-integration-data submodule is not required to use FIPD data files in BISON simulations.

Prerequisites

A user desiring the FIPD submodule with BISON will need FIPD access along with BISON. As the fipd-bison-integration-data submodule is not usually included in access to the rest of FIPD, access to the submodule will need to be specifically requested from the FIPD administrators.

Setup Access Token

Once access to the submodule's Git repository has been acquired, complete the first login to the repository through a web browser. Then, inside the User Settings, proceed to the Access Tokens area. Create a personal access token with the proper permission level for your work needs. Save the created token code somewhere safe; it will be needed in a future step and this is the only time to copy it.

Setup Git Submodule

The default settings needed to be changed to use the personal access token when updating the fipd-bison-integration-data submodule. In a terminal in the directory with the submodule, initialize the submodule:


git submodule init fipd-bison-integration-data

Next, open .git/config in your favorite text editor. Find the [submodule "fipd-bison-integration-data"] section and modify the "url" line:


url =  https://gitlab-ci-token:[email protected]/sfr-database/fipd-bison-integration-data.git

Replace ACCESS_TOKEN with the created token code that was stored somewhere safe. Save and close the file.

Updating FIPD Submodule

Now that the FIPD submodule is setup, the submodule may be updated at any time with:


git submodule update --checkout fipd-bison-integration-data

Data Protection

The data in fipd-bison-integration-data must be treated the same as data taken directly from FIPD in accordance to FIPD data protection requirements.

References

  1. Abdellatif M Yacout, Kun Mo, Aaron Oaks, Yinbin Miao, Tanju Sofu, and Walid Mohamed. FIPD: the SFR metallic fuels irradiation & physics database. Nuclear Engineering and Design, 380:111225, 2021.[BibTeX]