How to cite the UFS Weather Model code?

Hello, I am a member of the Vulcan Climate Modeling team, and am in the process of submitting a manuscript for publication in which I would like to cite the UFS weather model and acknowledge the UFS community more generally. Is there a recommended way to do this? I considered providing a link to the UFS weather model repo (https://github.com/ufs-community/ufs-weather-model) but as far as I can tell the repo currently lacks a DOI. Is it possible to add a DOI to the repository in order to be able to cite it? See a how-to here: https://guides.github.com/activities/citable-code/

Thanks!

Oliver

Hi Ligia, that is great and does meet my needs. Thanks!

 

Do you expect that new DOI's will be created with new releases of the UFS weather model? I know there is an automated linking from Zenodo to GitHub possible but not sure if it's been enabled here.

 

Oliver

Hi Oliver,

We have not decided yet on the DOI "policy" for the UFS. We are planning to create a DOI for the upcoming release of the UFS Short-Range Weather App. But it sounds that for you it would be helpful to have a DOI for the Weather Model itself. Can you confirm?

Maybe you have experience with this: Do you know how the submodules of a repo get handled with the automatic GitHub-Zenodo connection?

Thanks,

Ligia

 

 

Permalink

In reply to by ligia.bernardet

Hi Ligia,

But it sounds that for you it would be helpful to have a DOI for the Weather Model itself. Can you confirm?

Our group is basing our efforts on just the Weather Model and not using the App currently, so yes a DOI for the Weather Model would probably be more relevant.

Do you know how the submodules of a repo get handled with the automatic GitHub-Zenodo connection?

They will just be empty directories in the Zenodo zip. If making the DOI manually, one can just upload an archive of the whole repo including initialized submodules. But would need to make sure that authors of all the submodule repos are okay with that.

Oliver