Tools

Open Access Publishing at TUHH: Exemplary Step-by-step guide for a toolchain with TORE, GitLab, Sherpa Romeo and Zenodo

The following step-by-step guide is updated regularly and should be seen as a kind of living document. A more recent version, if available, can be viewed via the repository linked in the license note at the end of the post.

Publishing a paper as preprint would work as described in the following steps:

  1. You have to get an overview on possibilities to publish and open access sharing rights (further information on the websites of the TU library)
  2. Check the permissions of your journal or publisher where you would like to publish via Sherpa Romeo. Example for IEEE proceeding is:
Example for aggregated permissions of IEEE proceedings via Sherpa Romeo

Here you can see that preprints (research papers that are shared before peer review) are possible and which rules you have to follow. For example for CDC (Conference on Decision and Control) you can upload the preprint with a notice that this paper is submitted for review and afterwards you have to place a copyright notice and a DOI link of the IEEE finally published version. You are not allowed to publish the final version, just an author version with the copyright terms. See IEEE policy, section 3 for that.

  1. Create a repository for your publication in our gitlab instance: TUHH – Gitlab (private repo, a public repo can be seen here). In general you create

    • a repository for your paper
    • a repository for your software code (See Code Section)

Use the following scheme: Year-paper-conference-FirstSixWordsOfTitleOfYourPublication (e.g. 2021-paper-ECC-A-Gradient-Descent-Method-for-Finite) while the code is in the corresponding Year-code-TitleOfYourContribution repository.

  1. Have in mind to add references to supplimentary material in the readme.
  2. Add submission or copyright terms to your paper and create a prefinal pdf. You might keep some space (Where??) to place the preprint DOI for references.
  3. Open tore submission page with your personal account (more details via tore help).
  4. Select Publications with fulltext and click on manual submission
  5. The next pages collect metadata:
    • Title
    • Authors (Add an ORCID if possible, Add Prof Werner, for example). Clicking on the magnifier allows searching for entries. Validated entries are marked with a green arrow.
    • Select Language: English
    • Type: Preprint
    • Enter Abstract in English
    • Select TUHH Institute: Type E14 and by using the magnifier select the validated entry.
    • Go next
A click on the magnifier allows searching for entries
  1. Next page collects publisher metadata:
    • These information will be updated with the final version to be submitted for publication
    • Enter Date of issue: Todays date
    • Go next
  2. License details
    • License: Copyright should be selected
    • Supplemented by: Here you can add your Code DOI
    • Project: If you are working for a DFG program, you should reference it here
    • Funder: Here you should add DFG or BMWI as Funder
  3. Now you get your DOI.
    • Copy this DOI into your paper and compile it with this DOI. The DOI is booked but not finally registered. This will be done in the next steps
  4. Now, upload the pdf of your preprint
    • upload pdf
    • check filename (should be meaningful)
    • Set embargo date if neccessary
    • next
  5. Verfiy your submission and accept the license of TORE
  6. Your submission is nearly done. TUHH Library will check your submission. Either they accept it or ask you to change things. You will be emailed. Your entry is so to say, peer review on metadata level
  7. For now you are done. Further version have to be uploaded when the paper got accepted and you can upload the final author version to TORE. Please make sure that you reference the publisher DOI and add the correct credits to the paper.

Publish your software files related to your paper publication

You want to publish files like your source code, your data or videos in a save manner and cite them using a DOI?

The code you publish should be able to reproduce all figures you show in your publication by running one or multiple files which are than related to your figure. If your code uses special software or libraries to run, you should note them down in a dependancies and software section in a readme file of the repository. You should not include these files to your repository. Installation steps should be explained.

Than this is one way to go:

  1. Create a repository for your publication in our gitlab instance: TUHH – Gitlab. In general you create
    • a repository for your paper (See Paper Section)
    • a repository for your software code in https://collaborating.tuhh.de/ICS/ics-private/phd-students/papers (private repo) by using the following scheme: Year-code-conference-FirstSixWordsOfTitleOfYourPublication (e.g. 2021-code-ECC-A-Gradient-Descent-Method-for-Finite) while the paper is in the corresponding Year-paper-conference-TitleOfYourContribution repository.
  2. Upload your code by using git (You can use this repo already when starting to work on an idea: Repositories can be renamed and moved in the gitlab structure). Code should be cleaned up and except for dependancies and libraries selfcontaining. (Be careful on which branch to push, master gets automatically pushed to github, others not)
  3. Add a License file to the repo using templates: GPLv3 (Software) and CC-BY-SA (for all other media) and remove all lines after End of Terms and Conditions around line 625
  4. Add the following header lines to the beginning of each of your files. In references your refere to papers, software or tools you base on to cite them. Make sure that our license in compatible with the build on software/library/code.
```
%------
% Project: Name and Link
% Copyright: 
% License: 
% References:
% Authors:
%------

%---------------------------------------------------------------------------------------------
% For Paper, 
% "A Gradient Descent Method for Finite Horizon Distributed Control of Discrete Time Systems"
% by Simon Heinke and Herbert Werner
% Copyright (c) Institute of Control Systems, Hamburg University of Technology. All rights reserved.
% Licensed under the GPLv3. See LICENSE in the project root for license information.
% Uses an own implementation of the work of 
% "A. Vamsi and N. Elia, Design of distributed controllers realizable over arbitrary directed networks,
% IEEE Conference on Decision and Control, 2010."
% Author(s): Simon Heinke
%--------------------------------------------------------------------------------------------
```
  1. You also might want to enter a section in the Readme file on how to cite your work. Therefore you should include bibtex code for citing authors to reference your work in their publication. E.g.:
``` 
@misc{1606.01540,
    Author = {Greg Brockman and Vicki Cheung and Ludwig Pettersson and Jonas Schneider and John Schulman and Jie Tang and Wojciech Zaremba},   Title = {OpenAI Gym},
    Year = {2016},
    Eprint = {arXiv:1606.01540},
}
 ```

Example for Readme.md from Christian Hespe:

Example for a Readme.md file
  1. Create a repository at github.com/TUHH-ICS
    • with the same name as in gitlab
    • Give a short meaningful description
    • Select public
    • Click on create repository
    • Ask Lennart Heeren or Patrick Göttsch to grant you maintainer rights in that particular repository
    • Copy the SSH url from github
  2. Enable mirroring in gitlab
    • Switch to your private gitlab repository
    • Left menu -> Settings -> Repository -> Expand Mirroring repositories
    • Paste your github url in Input the remote repository URL
    • Modify it this way: ssh:// at the beginning and replace the colon after github.com with a slash. It should look like this now: ssh://git@github.com/TUHH-ICS/REPO_NAME
    • Klick on Detect host keys button
    • Select (although it does not seam to be clickable) in authentification method SSH Public Key
    • And select Mirror only protected branches. By default only the master branch will be pushed as it is.
    • Click on mirror repository to setup the mirror.
    • Now you have to click on the Copy ssh public key
Copy the ssh public key via mousclick on the copy item
  • After a click on the key…
    • go back to GitHub;, click on Settings > Deploy Keys > Add deploy key
    • Give it some title, paste the copied key in the key field and check Allow write access abd than click on Add key
    • Now you can trigger the mirroring by pushing or merging into the master branch in gitlab or manually in the gitlab repo mirroring settings page
  1. Uploading to Zenodo
    • Login to Zenodo using ** Log in with this credentials **
      • user: ics@tuhh.de
      • passwd: JJ^Q?…
    • Click on setting->github (1),
    • Click on Sync now button (2),
    • and enable the repository (3, located at the end of the list),
    • Then we go back to github and create a new release (4):
  • give a version tag like v1.0
  • give a meaningful title
  • and some description (will also be published by zenodo)
  • click on Publish Release
Click on „Publish release“ after assigning a tag, a title and a description

This automatically generates a zip of the code and this zip gets uploaded to zenodo, also automatically.

  1. Creating a DOI/Publishing
  • Back in Zenodo click on upload at the top of the page
Upload-Button
  • Here you find your software code already published
Published software code
  • Since not all metadata is available on github, you have to edit your entry
    • Click on the title opens the entry and shows a view as readers would see it.
    • You can click on edit to add or change metadata. The next view is organised in multiple sections:
      • Files: Here you can upload a new version manually. But normmaly you would choose a github release as the way to go.
      • Communities: Please select Hamburg University of Technology to reference this contribution to TUHH
      • Upload Type: Should already be Software
      • Basic Information:
        • Adjust the Title because the github repo name has been used. E.g.: Code for paper: Name of my marvellous paper
        • Authors: Clean up authors list; Lastname, Firstname – Hamburg University of Technology – Institute of Control Systems – ORCID
        • Add Prof Werner to this list: Werner, Herbert Hamburg University of Technology – Institute of Control Systems – 0000-0003-3456-5539
        • Add a meaningful Description
        • Version tag got automatically set
        • Language: Choose English
        • Give similar Keyword as you choose for your paper
      • License: All should be okay. The License is provided in the repository. Zenodo so far does not support GPLv3.
      • Funding: Select nothing
      • Save the changes. And when you think they can be published, hit the publish button.
  1. Cite code
    • use Zenodo Bibtex generator to get a bibtex entry of your code for your latex literature file – Export section (bottom right)
BibTeX code export via Zenodo

Put a DOI patch into the readme -> Use latest version DOI by clicking on the DOI entry (1) and copying the markdown code (2) from the window. You can add a badge to your gitlab repo as well, either in the readme (2) or by adding a batch using (3a) and (3b)

Zendodo DOI Badge

You might want to change the DOI to the DOI for the latest version:

Adjust the DOI
  1. Updating
    • Create new release on github
    • update Description on zenodo
CC BY 4.0
Weiternutzung als OER ausdrücklich erlaubt: Dieses Werk und dessen Inhalte sind – sofern nicht anders angegeben – lizenziert unter CC BY 4.0. Nennung gemäß TULLU-Regel bitte wie folgt: Open Access Publishing at TUHH: Exemplary Step-by-step guide for a toolchain with TORE, GitLab, Sherpa Romeo and Zenodo von Patrick Göttsch, Christian Hespe, Adwait Datar, Simon Heinke und Lennart Heeren Lizenz: CC BY 4.0. Eine ggf. aktualisierte Version des Workflows kann über dieses GitLab-Repositorium abgerufen werden.
Kuerbisse

Monatsnotiz Oktober/November 2021 – Semesterstart, Open Access und digitale Adventskalender

Die Monate Oktober und November sind (fast) vorbei. In dieser Monatsnotiz habe ich einige Dinge festgehalten, mit denen ich mich in den vergangenen Wochen und Monaten beschäftigt habe.

Start des Wintersemesters

Die Sommerpause ist vorbei und das Wintersemester 2021/2022 ist gestartet – und das im Gegensatz zu den vergangenen Semestern mit der Möglichkeit, sich in Lehrveranstaltungen gemeinsam vor Ort auszutauschen. Das betrifft bei mir in diesem Semester vor allem zwei Veranstaltungen. Unser Bachelorseminar „Wissenschaftliches Arbeiten“ und die Übernahme einiger Termine in der Vorlesung „Einführung in die VT/BioVT“.

Im Gegensatz zu vergangenen Semestern bleiben die Vorlesungs- und Seminarräume bislang im Wintersemester 2021/2022 nicht leer (Foto: Florian Hagen, CC BY 4.0)

Bachelorseminar „Wissenschaftliches Arbeiten“

Unser Bachelorseminar „Wissenschaftliches Arbeiten“ findet auch dieses Semester wöchentlich statt. Wie in den vergangenen Durchgängen ist die Nachfrage erfreulich hoch. An Themen haben wir im Seminar in den vergangenen Wochen und Monaten begonnen, über unterschiedliche Aspekte des wissenschaftlichen Arbeitens zu sprechen, die die Studierenden im Rahmen der Erarbeitung eines eigenen Themas nutzen (können). Dazu gehören neben unterschiedlichen Methoden der Ideenfindung unter anderem Ansätze für eine strukturierte Themeneingrenzung, die Erarbeitung einer Forschungsfrage, unterschiedliche Recherchestrategien, Literaturverwaltung und ganz aktuell die Anfertigung eines Exposés. Schön ist vor allem der aktive Austausch. Ich nehme dieses Semester bisher viel mit, was genutzte „Werkzeuge“ und Methoden der Studierenden angeht und unsere Coaching-Sessions (hier gibt es kürzere Inputs und im Anschluss Zeit für die Weiterarbeit am eigenen Schreibprojekt oder individuelle Beratung) werden gut genutzt, um im Austausch Ideen und Schreibvorhaben voranzubringen.

Vorlesung „Einführung in die VT/BioVT“

Dieses Semester bin ich zusammen mit meinem Kollegen Detlev Bieler das erste mal regelmäßig an der Veranstaltung „Einführung in die VT/BioVT“ beteiligt. Unsere Aufgabe ist hier vor allem, einen Einblick in das wissenschaftliche Arbeiten zu geben. Dazu werden Themen wie der Umgang mit Fachinformationen, Literaturverwaltung und das eigene Schreibverhalten besprochen und reflektiert. Im Grunde handelt es sich also um eine stark komprimierte Variante unseres Bachelorseminars „Wissenschaftliches Arbeiten“. Bisher hat mein ehemaliger Kollege Thomas Hapke diese Veranstaltung mitbegleitet und dazu einige Informationen auf der Seite Lehrinnovations-Projekt Verfahrenstechnik festgehalten.

Campus Rallye „WiMis GettIng Started“

Zusammen mit einigen Kollegen durfte ich die Bibliothek als eine Station bei einer Campus-Rallye vertreten. Diese wurde für neue wissenschaftliche Mitarbeiter:innen der TUHH – aktuell natürlich unter Berücksichtigung der aktuellen Lage – im Rahmen der Kick-off Veranstaltung „WiMis GettIng Started“ angeboten, um unter anderem die Vernetzung untereinander zu unterstützen. In Kleingruppen haben wir in der Rotunde der tub. einen kurzen Einblick in die Arbeit im Fachreferat und Services der Bibliothek gegeben. Daneben konnte uns natürlich mit etwas Geschick auch die Lösungsfrage zu einer der Aufgabenstellungen der Campus-Rallye mehr oder weniger entlockt werden 😉

Blick durch das Glasdach der Rotunde in der tub. (Foto: Florian Hagen, CC BY 4.0)

Im Vergleich zu den letzten Monaten war also viel los auf dem Campus.

Rückblick auf Blogbeiträge

Fast pünktlich zum Semesterstart habe ich den Beitrag Wenn ich nochmal Ersti wäre veröffentlicht, in dem ich einige Tipps festgehalten habe, die ich mir geben würde, wenn ich nochmal Ersti wäre. Wer weitere Ersti-Tipps hat, ist herzlich dazu eingeladen, diese im Kommentarbereich des verlinkten Beitrags zu teilen.

Durchaus passend dazu (wenn auch bereits Ende September veröffentlicht) habe ich ein kurzes Tutorial zur Open-Source-Anwendung uMap verfasst. Mit uMap lassen sich individuelle, interaktive Karten mit wenigen Mausklicks erstellen und so beispielsweise automatisierte Campus-Rundgänge oder individuelle Wegbeschreibungen abbilden. Einige Ideen für Karten habe ich im Beitrag festgehalten. Vielleicht habt ihr aber auch noch Anregungen oder bereits Erfahrungen, was mithilfe von uMap möglich ist?

Wer gerade nach ungewöhnlichen Wegen aus der Schreibblockade sucht oder einfach Interesse an ungewöhnlicheren Anwendungen hat, könnte einen Blick in den Beitrag #Fundstück: Mit Musik aus der Schreibblockade – typedrummer werfen. Typedrummer ist eine Anwendung, die Texte in Beats und Töne verwandelt und bei mir so fast unbemerkt die fehlende Schreibmotivation weggezaubert hat.

Nicht zuletzt möchte ich auch den tub.torials-Beitrag Online-Fortbildungen mit HedgeDoc und Greenshot dokumentieren erwähnen. Mein Kollege Gunnar Weidt zeigt hier, wie er mithilfe von zwei Open-Source-Anwendungen Veranstaltungen ohne lange Mauswege und Klickstrecken dokumentiert.

Open Access

Auch in den vergangenen Wochen gab es natürlich viele lohnenswerte Veranstaltungen rund um Open Access und Open Science.

Online-Workshop Single Source Publishing Community (11.10.2021)

In der Monatsnotiz Juni/Juli habe ich kurz über die neue Single Source Publishing Community berichtet, die unter anderem vom ehemaligen Team Modernes Publizieren mit ins Leben gerufen wurde. Am 11. Oktober haben wir nun unseren ersten Workshop angeboten, der den Startschuss für einen langfristigen Austausch zwischen Entwickler:innen und Nutzer:innen von Publikations-Werkzeugen und -Plattformen bilden soll. Details wie die Agenda des Workshops können im Forum der Community nachgelesen werden, zu der Interessierte an dieser Stelle nochmal herzlich eingeladen sind.

Open Access Week 2021 (25.10. bis 31.10.)

Die Open Access Week 2021 fand in der Zeit vom 25. bis 31. Oktober 2021 statt. Wir als tub. haben uns auch dieses Jahr mit einem Programm beteiligt, dass eine Mischung aus Blogbeiträgen, Open-Access-Sprechstunden und Audioaufzeichnungen bot. Besonders ans Herz legen möchte ich an dieser Stelle nochmal den Beitrag Warum ich Open Science unterstütze von Prof. Dr.-Ing. Tobias Knopp (Institute for Biomedical Imaging, TUHH). Dieser führt in seinem Beitrag drei Gründe auf, die für Open Science sprechen.

Wer Interesse am Thema Open-Access-Finanzierung mit der tub. hat, findet im Beitrag Wie finanziere ich meinen Zeitschriftenartikel? von meiner Kollegin Isabo Schick neben Informationen in Textform auch eine schöne Übersicht zu internen Abläufen im Flowchart-Format. Unklarheiten rund um Open-Access-Begrifflichkeiten lassen sich ergänzend vielleicht mit einem Blick in unseren Open-Access-Glossar klären.

Online-Diskussion „Sind wir mit dem kommerziellen Open Access auf dem richtigen Weg?“ (22.11.2021)

Live konnte ich leider nicht an der Online-Veranstaltung „Sind wir mit dem kommerziellen Open Access auf dem richtigen Weg?“ teilnehmen. Die knapp 90-minütige Diskussion mit Dr. Jens Peter Gaul (Generalsekretär der Hochschulrektorenkonferenz), Dr. Ulrich Herb (Leiter Abteilung Elektronische Publikationsangebote an der Saarländischen Universitäts- und Landesbibliothek) und Dr. Anja Oberländer (Leitung Team Open Science am Kommunikations-, Informations-, Medienzentrum (KIM) der Universität Konstanz) ist erfreulicherweise aber schon als Aufzeichnung über das AV-Portal der TIB verfügbar. In der Veranstaltung, die Dr. Christina Riesenweber (Universitätsbibliothek der Freien Universität Berlin) moderierte, wurde zunächst der Begriff „kommerzieller Open Access“ definiert, bevor ein Blick auf das Verhältnis von großen Open-Access-Initiativen gegenüber vielen kleinteiligen Alternativoptionen, die eher disziplinspezifisch sind, geworfen wurde. Auch die Preisentwicklung bei Open-Access-Publikationen in einzelnen Fächern war Diskussionsgegenstand. Hier wurde zum Beispiel angemerkt, dass der Preis von Open Access nicht von der Qualität der Verlagsdienstleistungen oder der Qualitätssicherung und Reputation des Journals abhängt, sondern von der Verfügbarkeit des Geldes „auf dem Markt“. Fokus lag auch auf der Bedeutung, die die Stärkung von Alternativen gegenüber dem kommerziellen Open Access haben, um die zunehmende Marktmacht von Verlagen sowie steigenden Kosten entgegenzuwirken. Genannt werden können hier beispielsweise Zweitveröffentlichungen über den grünen Open-Access-Weg und scholar-led Open-Access-Journale. Auch Investitionen in Infrastruktur statt einseitiger Unterstützung von Subskriptionsmodellen seien hier zu nennen.

Dies und das im Tagesgeschäft

Im Oktober und November spielten – wie auch schon in den vergangenen Monaten – natürlich auch viele klassische Aufgaben in meinem Fachreferatalltag eine Rolle. Dazu zählen neben der Webseitenpflege, Veranstaltungsplanungen für das kommende Jahr (Konkretisierung von Inhalten, Themen, Zielen, etc.), die Bearbeitung von Anschaffungsvorschlägen oder auch Beratungsgespräche zu unterschiedlichen Themen wie Open Access, Wissenschaftliches Arbeiten oder Literaturverwaltung.

Ausblick

Weihnachten steht vor der Tür. Und ich freu mich riesig. Natürlich vor allem auf die freien Tage, aber auch auf einige spannende digitale Adventskalender. Meine Kollegin Sarah Capell hat für den Instagram-Account der tub. einen Adventskalender organisiert, der täglich einen Blick hinter die Kulissen der tub. bietet. Wer also schon immer mal wissen wollte, welche Mitarbeiter:innen bei uns im Haus mit welchen Aufgabenbereichen verbunden sind, sollte auf jeden Fall mal hereinschauen.

Nele Hirsch hat mit ihrer Idee Internetquatsch sicherlich nicht wenige digitale Veranstaltungen in den vergangenen Monaten bereichert. Pünktlich für den 1. Dezember hat sie nun den Start des Internetquatsch-Adventskalenders 2021 angekündigt. Da freue ich mich sehr drauf und bin gespannt, welche Ideen vielleicht auch wieder Inspiration für meine eigenen Veranstaltungskonzepte der kommenden Monate werden.

Last but not least sei an dieser Stelle auch nochmal auf den Adventskalender unseres ehemaligen HOS-Projektes „Modernes Publizieren“ hingewiesen. Hinter 24 Türchen hat unser Projektteam hier im Jahr 2020 einen Open-Access-Adventskalender mit Texten, Software, Grafiken und Ideen rund um Open Science und offenes Publizieren veröffentlicht. Eine Projektphase, an die ich vor allem dank des tollen Projektteams sehr gerne zurückdenke.

Habt ihr noch Empfehlungen zu digitalen Adventskalendern rund um Openness, Tools, Wissenschaft, Lernen, Lehren und Bibliotheken? Teilt diese doch gerne über die Kommentarfunktion. Ansonsten wünsche ich an dieser Stelle eine ganz tolle, hoffentlich auch erholsame Weihnachtszeit. Bis zur nächsten Monatsnotiz 🙂


CC BY 4.0
Weiternutzung als OER ausdrücklich erlaubt: Dieses Werk und dessen Inhalte sind – sofern nicht anders angegeben – lizenziert unter CC BY 4.0. Nennung gemäß TULLU-Regel bitte wie folgt: Monatsnotiz Oktober/November 2021 – Semesterstart, Open Access und digitale Adventskalender von Florian Hagen, Lizenz: CC BY 4.0. Beitragsbild „Kürbisse“ von Florian Hagen (CC BY 4.0). Der Beitrag und dazugehörige Materialien stehen auch im Markdownformat und als PDF zum Download zur Verfügung.
1 2 3 4 5