Warning, /epic.github.io/_documents/zenodo.md is written in an unsupported language. File is not indexed.
0001 ---
0002 title: The Document Database
0003 name: zenodo
0004 layout: default
0005 ---
0006 {% include layouts/title.md %}
0007
0008 The ePIC Collaboration is leveraging [Zenodo digital repository](https://zenodo.org/){:target="_blank"}
0009 for its document management capability. Zenodo is an open-source data repository designed for managing
0010 research materials in diverse areas of science. Our Collaboration is using a public instance
0011 of this system called **zenodo.org** which is supported by CERN, OpenAire and the European Union.
0012 For more information, consult the [zenodo.org FAQ](https://help.zenodo.org/faq/){:target="_blank"}.
0013
0014 Materials committed to Zenodo can be assigned to collections specific to, and managed by
0015 an organization. Such collections are termed "communities". The ePIC
0016 materials are managed as the
0017 ["ePIC Community on Zenodo"](https://zenodo.org/communities/epic/){:target="_blank"}.
0018 While most materials published on this platform are public, a fraction has a protected
0019 status and requires membership in the community (in our case it's **ePIC Community**).
0020
0021 **The membership
0022 status can be granted to the ePIC members by the community managers, once they send a request to
0023 <eic-software-l-request@lists.bnl.gov>.**
0024
0025
0026 {{ site.hr }}
0027 #### How To Upload A Document to Zenodo
0028
0029 Start by navigating to [<span
0030 class="underline">Zenodo.org</span>](http://zenodo.org) and log in or
0031 create an account. Either process is simple and straightforward. If you
0032 are creating a new account, consider using either a ORCID or GitHub sign
0033 in to simplify the process. In particular, ORCID is a unique, persistent
0034 identifier that can be used across multiple platforms. For more
0035 information, visit [<span
0036 class="underline">orcid.org</span>](https://info.orcid.org/what-is-orcid/).
0037
0038 Once you are logged in, go to your Dashboard, as shown on the right
0039 below:
0040
0041 <img src="/assets/images/zenodo/ZenodoLogin.png" style="width:2.2708in;height:3.51667in" />
0042
0043 <img src="/assets/images/zenodo/ZenodoDashboardLink.png" style="width:4.17161in;height:0.47064in" />
0044
0045 In your Dashboard in the upper right-hand corner you will see a button
0046 that will start the process of uploading a new document.
0047
0048 <img src="/assets/images/zenodo/NewUpload.png" style="width:1.7in;height:0.71667in" />
0049
0050 <img src="/assets/images/zenodo/NewUploadForm.png" style="width:6.49167in;height:4.54167in" />
0051
0052 From this form you can upload your file and answer some basic questions
0053 to allow the submission to be categorized. Don’t panic! There’s a lot of
0054 information requested in this form, but only some is required.
0055
0056 The first thing that you will want to do is to associate this upload
0057 with the ePIC Community. Hit the “Select a Community” button at the top
0058 of the page, and type in “ePIC” – the ePIC Experiment will be at the top
0059 of the list of communities for you to select.
0060
0061 You can now fill in the metadata for your upload. At a minimum, your
0062 upload should include the following information:
0063
0064 - A DOI (Digital Object Identifier). If you already have one you can enter it on the form, if you don’t select “No” and a button will appear that will allow you to generate one for your document.
0065 - Select a descriptive title and publication date. If this is a conference presentation, it is helpful if you use the date you made the presentation. Otherwise, you can just enter today’s date.
0066 - You will need to add information about the creator of this document. Typically this is you, but you can add multiple creators if that is appropriate. If you have an ORCID ID, it’s best to enter this in the form to add a creator as that uniquely identifies you.
0067 - Add a meaningful description.
0068 - The default license for the document (Creative Commons Attribution 4.0 International) is usually fine. If you want a specific license, you can select one here.
0069
0070 This is all the required information by Zenodo, but to make the document
0071 easy to find for your fellow collaborators you should add one or more
0072 keywords. All ePIC documents should include at a minimum the “epic-eic”
0073 keyword. Additional keywords for ePIC documents are maintained on the
0074 [<span class="underline">ePIC
0075 website</span>](https://www.epic-eic.org/documents/keywords.html). If
0076 you are unsure of the keywords, don’t worry, the curator will check the
0077 keywords and update them if necessary.
0078
0079 You can also fill in additional information on funding, publisher,
0080 related works, and alternate identifiers. You can also include
0081 references to software repositories, but none of these are necessary.
0082
0083 The last thing you have to do is decide if your document will be
0084 “Public” or “Restricted”. A “Public” document is available to the world.
0085 This might be appropriate for a conference presentation or proceedings.
0086 A “Restricted” document is only available to members of the ePIC
0087 community.
0088
0089 <img src="/assets/images/zenodo/Visibility.png" style="width:3.96667in;height:2.91667in" />
0090
0091 The last step is to submit your document for review. Click the “Submit
0092 for Review” button in the upper right hand corner. Your document will be
0093 queued for approval by a DSC Leader, WG Convener or Conference Committee
0094 Chair or Vice-Chair. There is no automatic notification, so it would be
0095 a good idea to email the relevant person or persons and let them know a
0096 document is available for approval.
0097
0098 <img src="/assets/images/zenodo/SubmitForReview.png" style="width:3.975in;height:2.21667in" />
0099
0100 If there are any problems with the information Zenodo.org will let you
0101 know and you can correct it and resubmit.
0102
0103 {{ site.hr }}
0104 #### How To Approve A Document Submission to Zenodo
0105
0106 Under **My Dashboard -> Requests** (or **My Dashboard ->
0107 Communities -> ePIC -> Requests**) click on the request that you
0108 want to review. You can also get there from the link sent in the
0109 notification email titled “📥 New record submission to your community
0110 'ePIC'”.
0111
0112 <img src="/assets/images/zenodo/NewSubmission.png" style="width:6.5in;height:1.875in" />
0113
0114 After clicking on the request title, go to the **Record** tab**.**
0115 Review the metadata, like, e.g., conference name, description, etc. Most
0116 importantly, check if the proper keyword has been added to the entry
0117 (list of keywords: [<span
0118 class="underline">https://www.epic-eic.org/documents/keywords.html</span>](https://www.epic-eic.org/documents/keywords.html)).
0119
0120 If you see that some metadata requires modification you can either fix
0121 it yourself by clicking **Edit**, or in the **Conversation** tab request
0122 changes from the person submitting the record. In particular, check the
0123 keywords - Is the required keyword “epic-eic” included? Are there other
0124 keywords specific to the Working Group or DSC that should be added?
0125
0126 <img src="/assets/images/zenodo/EditSubmission.png" style="width:2.08854in;height:2.17142in" />
0127
0128 If all issues has been resolved click **Accept and publish**
0129
0130 <img src="/assets/images/zenodo/AcceptAndPublish.png" style="width:6.5in;height:0.72222in" />