Skip to content

Contribute

Submit a package to the Data Bank

You developed a code with an application in nuclear science and technology and you are willing to share it worldwide through the NEA Data Bank? First, thank you!

Here are a few steps to guide you through the submission process:

  • Make sure your institution agrees with an NEA Data Bank distribution. Particularly if your code may have possible "dual-use" applications, please contact your national representatives to first obtain the clearance for an NEA Data Bank distribution and to address any export controls. If you need assistance reaching these individuals please contact us.
  • CPS distribution typically results in complete beginners attempting to use your code. Thus, you are kindly asked to prepare the relevant support material:
    • User manual
    • Installation guide
    • Test problems with input and reference output files
    • Ideally, reports on the validation procedure used and information on validation/benchmarking and the reference peer-reviewed publication(s) are also valuable support material.
    • If you know of any document relevant to your code (such as reports describing benchmarking, experience, applications) but not available from you, please provide details of its reference.
  • Please contact us to obtain our draft bilateral legal agreement for use between the NEA and the owner entity. The agreement has options to suit your needs, including restrictions for non-commercial use, restrictions on end-use cases, and more.
  • As part of the agreement process, a complete abstract documenting the package itself must be prepared, wiht some or all of this content made available on our public website for users to launch licensing request processes.
  • Upon reception of your package, the CPS team will work with you to test your code, including upload to our local version control and compute infrastructure to perform compilation/install and verification tests.
    • For users unfamiliar with git or DevOps, the Data Bank offers training by staff who are certified trainers with the Software Carpentries. Please reach out to us for more information.
  • Depending on owner requirements, software can be hosted within the NEA Data Bank GitLab with individuals accessing through single user accounts with multi-factor authentication.
    • Users can optionally have only read access or may propose modifications through the system for Owner review.
    • All CPS software has protected main/master content that may never be modified by non-Owner accounts.

If you have any question at any step of the process, please feel free to contact us for clarifications.

Updates to Data Bank packages

If you are willing to update the version of the program distributed by the NEA Data Bank, our suggested method is to store all content within the NEA GitLab including all versions within one repository. You may decide to offer access to all versions within this platform or create specific release packages available to users.

For packages that were submitted to the Data Bank prior to the implementation of GitLab-based services, CPS can help support transition to GitLab with or without substantive changes to your package. Legacy static package management may exceptionally still be allowed. Please contact us for more information.

For all package updates, CPS must update the abstract to highlight the new features of the code update. This material must be submitted to CPS and finalised with the updated version of your program, including the updated support material (User's manual, installation guide, test cases input and output files). If you know of any new document relevant to your code, please provide details of its reference.