You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Sharing](share-your-code) and making your code **citable** supports others **acknowledge your work, build upon it, and give you credit**. Citation further supports making workflows open and documenting all parts of the scientific process.
20
20
@@ -29,7 +29,6 @@ kernelspec:
29
29
30
30
31
31
<iclass="fa-solid fa-rocket"></i> This lesson assumes that your code is already **hosted on [GitHub or GitLab](share-your-code) with an [open license](open-license).**
32
-
:::
33
32
34
33
(zenodo)=
35
34
## What is Zenodo?
@@ -60,7 +59,6 @@ Each release gets a unique DOI, while the repository keeps a persistent record,
60
59
1. Go to [zenodo.org](https://zenodo.org/) and sign in using your GitHub account
61
60
2. Go to your profile drop-down and select “GitHub
62
61
63
-
64
62
:::{figure} /images/zenodo/zenodo-account.png
65
63
:alt: Text here
66
64
@@ -147,14 +145,11 @@ Be sure to use the cite-all versions badge, which will always resolve to the mos
147
145
Once you have created a GitHub release, you will see a badge next to the repository with a DOI. You can click on that badge to get a copy-able markdown version of the rendered badge that you can add to your README file.
148
146
:::
149
147
150
-
151
148
### Step 6: Optional--Add your DOI to the GitHub repo: the citation.cff file
152
149
153
150
Now that you have a DOI, add a [CITATION.cff](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) file to your GitHub repository to make it easy for others to cite your package.
154
151
Once you have a DOI, you can add a [citation.cff file](https://citation-file-format.github.io/) to your GitHub or GitLab repository. A `CITATION.cff` file standardizes citation information, making it easy for others to cite your work correctly.
155
152
156
-
157
-
158
153
## What is a DOI?
159
154
160
155
A **DOI**, or **Digital Object Identifier**, is a unique, permanent identifier assigned to digital content such as academic papers, datasets, software, and other research outputs. It acts like a stable web link that always directs users to the reference content, even if the location of the content changes. DOIs are commonly used in academic publishing to ensure that citations remain valid and materials are easily accessible. But you can also assign DOIs to software, data, and other research outputs and supporting elements.
@@ -165,9 +160,8 @@ By using a DOI, you can make your work more discoverable and citable, enabling o
165
160
166
161
There are multiple ways to get a DOI for your work and to make your code citable. Each way has its own benefits:
167
162
168
-
169
163
1.**Write and publish a paper about your code in a journal like JOSS (Journal of Open Source Software) via pyOpenSci** if you have written a Python package or another methods-focused scientific Journal. If you go the publication route, you will receive a cross-ref DOI that can be easily connected to your ORCID.
170
-
3.**Use a platform like [Zenodo](zenodo)**. If you use Zenodo to create a DOI for your work, you will receive a DOI that is not CrossRef compatible. However, you can still add entries for that DOI in your ORCID profile page.
164
+
1.**Use a platform like [Zenodo](zenodo)**. If you use Zenodo to create a DOI for your work, you will receive a DOI that is not CrossRef compatible. However, you can still add entries for that DOI in your ORCID profile page.
171
165
172
166
### CrossRef vs. Zenodo DOIs - What's the difference?
0 commit comments