Helmholtz Services

### INFO * press 'S' for speaker notes (allow pop-ups) * press 'ESC' for overview mode * press 'CTRL'/'ALT'/'CMD' + 'left click' to zoom

### about:me * Maximilian Dolling * environmental informatics @ HTW-Berlin * RSE @ eScience Centre * [Helmholtz Software Services][HIFIS] [HIFIS]: https://software.hifis.net/

### about:content We do a little story of an example PHD in terms of its software development 1. Helmholtz Services, that assist us 2. Quality Requirements for Software Projects 3. Q&A <aside class="notes" data-markdown> * past activities * highlights * outlook </aside>

### What are Helmholtz Services?

* Software that others run, and we can use * free of charge * hosted by Helmholtz Centers and projects

In the scope of this lecture we are talking about services from the following providers: * [GFZ](http://intranet.gfz-potsdam.de/en/topics/it/) * [HIFIS](https://hifis.net/) * [HIDA](https://www.helmholtz-hida.de/en/) * [Helmholtz AI](https://www.helmholtz.ai/)

GFZ

advantages

• well established within GFZ
• more and faster support

disadvantages

• hard to use with external partners
• some services are old fashioned (e.g. chat)

Other Services

advantages

• easy usage with most other Helmholtz Centers
• more modern software
• additional services

disadvantages

• mostly beta phase

### Start of the career

There is this publication of Kumar et al. 2018 which uses a novel technique to analyse the samples we have brought from the last field trip. I suggest you try to replicate the analysis using the new samples. Here is the data!

### Investigating the Data

There is this database of historical data of the bespoken area. The trend we have been seeing should also be visible in some of the data. Unfortunately there more than 20.000 entry in the database and about 10 GB of data.

We obviously cannot make that manually. We could code our solution - but how?

The [educational services from HIFIS](https://software.hifis.net/services/training) will help you.

We offer lectures and workshops around software development: * various programming languages * code quality and code publication * supportive tools like git GitLab and Docker

### Start Coding

We now want to start our project. Coding creates lots of files - where to we store them? Also we need to organize our project, to keep track of: * future tasks * bugs * specific versions * documentation

GitLab is the place to do that. * [HIFIS Gitlab](https://gitlab.hzdr.de) * [GFZ GitLab](http://git.gfz-potsdam.de), [description](http://intranet.gfz-potsdam.de/themen/it/server-dienste/git/)

GitLab is a tool to: * store code * keep track of different versions * project management

### The team grows

During our project, we collaborate with other researchers. We need to organize a bigger team now. Especially in times where most of us work from home, we need a digital solution.

We are particular interested in: * communication channels * shared calendars * data storage * collaboratively write papers or reports

* [Mattermost](https://mattermost.hzdr.de/hifis/channels/town-square) helps us communicate. * [HZB Nextcloud](https://nubes.helmholtz-berlin.de) is an office cloud services. * [KIT Nextcloud](https://bwsyncandshare.kit.edu/) is an office cloud services. * [GFZ Nextcloud](https://nextcloud.gfz-potsdam.de/apps/dashboard/) is an office cloud services. * [GFZ Chat](http://intranet.gfz-potsdam.de/en/topics/it/server-and-services/chat-server/) * [GFZ-Webconf](http://intranet.gfz-potsdam.de/en/topics/it/server-and-services/web-conferencing/) * [GFZ-ShareLaTeX](http://intranet.gfz-potsdam.de/en/topics/it/server-and-services/sharelatex-server/)

Other communication tools: * [jitsi](https://meet.desy.de) (beta) provides video conferencing. * [BBB](https://bbb.hzdr.de/) (beta) provides video conferencing.

### Computational Resources

When we first try our software on the full data set, it runs forever. Our local machines are so loaded that we cannot work anymore. We need some external computing power.

* [GFZ Computing Cluster](http://intranet.gfz-potsdam.de/en/topics/it/server-and-services/compute-server/) * [OpenStack](https://hdf-cloud.fz-juelich.de/) provides virtual computers. * [JupyterHub](https://jupyter-jsc.fz-juelich.de) provides Jupyter Notebooks for Python, Julia and R. > You need to apply separately to access this services.

### Publishing

We want to publish our research in a journal. Quite common nowadays, the journal wants to have access to the source code. To fulfill that request, we need to bring our software in shape.

What is the purpose of your code publication?

just look, don't touch -or- presenting yourself -or- community development <aside class="notes" data-markdown> * bare minimum * in a good way * focus on community </aside>

Checklist

just look, don't touch

1. check and add license
2. make it a git repository
3. use code hosting platform
4. add citation file
5. get DOI

presenting yourself

6. use a style guide
7. add authors list
8. document your code
9. run/make script(s)
10. (test your software)

community development

10. test your software
11. add contribution guide

* [Code Publishing Lecture](https://id2.git-pages.gfz-potsdam.de/public/lectures/requirements-for-code-publication/#/)

### It's complicated

All of this tools, workflows, and software development in general can be quite complicated. It might happen that we can not figure out a solution for occurring problems.

* [HIFIS Helpdesk](https://support.hifis.net) provides consultation for problems around software development.

We can help you with: * licensing issues * solutions on how to improve your software * setting up a new projects * software engineering topics (requirements engineering, software architecture, testing, ...)

### Questions!