worlddynamics / Vensim2MTK.jl

A Julia package to import Vensim .xmile files as ModelingToolkit.jl models.
MIT License
2 stars 1 forks source link

Get a DOI for the package #26

Closed natema closed 1 year ago

natema commented 1 year ago

We can ask a DOI on Zenodo, so that we can make it possible for people to cite the software if they use it in some project, as we did for WorldDynamics: https://github.com/worlddynamics/WorldDynamics.jl#how-to-cite-this-work .

meyde commented 1 year ago

so how do Zenodo works? i'm a bit confused

natema commented 1 year ago

I don't remember by heart, but it shouldn't be hard to follow the online documentation: https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content .

meyde commented 1 year ago

i can only register repository that i own, for the one in an organisation, there is a need to authorize something in the organisation side

"If your organization's repositories do not show up in the list, please ensure you have enabled third-party access to the Zenodo application. Private repositories are not supported."

(and the repo indeed does not appear)

natema commented 1 year ago

I don't see how to enable that.

natema commented 1 year ago

I managed to give Zenodo access to the repo. As soon as the first release is out (#27), we can get a DOI.

natema commented 1 year ago

Zenodo already generated the DOI for the project: https://zenodo.org/account/settings/github/repository/worlddynamics/Vensim2MTK.jl . Feel free to do a PR adding the badge and the how-to cite on the README.

meyde commented 1 year ago

i'm writing the how-to-cite by looking at the examples written in the other modules in worlddynamics, and i have a question: in @software{pierluigi_crescenzi_2022_7093581, ....
Should i change this name to yours? and with what id to follow?

natema commented 1 year ago

The id is arbitrary, you can make it up, e.g. vensim2mtk_2023.

meyde commented 1 year ago

alright