Usage Overview

Installation

Be sure to have Python 3 installed.

Note: The application has only been tested on Python 3.10.

If you encounter any issues, see the troubleshoot section below.

To install the application, run:

pip install dsp-metadata-gui

Or respectively:

pip3 install dsp-metadata-gui

Run

Once installed, you can start the tool from your terminal:

dsp-metadata

Collect metadata

The application is divided into two main parts: Project Organization and the Form for collecting Metadata.

In the Project Organization, you can organize all projects, for which you want to collect metadata.
At first, you will need to add a new project. For that you need the project shortcode, which is provided by the DaSCH Client Services. (If you don't have your shortcode yet, get in touch.)
After adding at least one project, you can select a project in the list and perform several actions, like editing the data or exporting an RDF serialization of the project metadata.

When editing a project the form for collecting metadata opens up.
There are multiple tabs, where data can be entered for several classes like:

• Organization
• Person
• Grant
• Dataset
• Project

Note: The order may seem counter intuitive, not starting from the project and dataset. However, following the order of the tabs is recommended, as e.g. person depends on organization, etc.

Troubleshoot

There is a number of known issues. In these cases, please try the following workarounds.

• There have been issues with conda installations. If this is the case, consider using a virtual environment.

• In some instances (typically on Mac OS, when python has not been installed with Homebrew), installation works but when running the tool, a SSL error occurs.
  In that case you can either locate your python installation in Applications > Python 3.10 and double-click the file Install Certificates.command. Alternatively, it should work if you install python via Homebrew.

• On Mac M1 Silicon devices, Pillow may cause issues when installing dsp-metadata-gui with pip. If you run into the error: "The headers or library files could not be found for zlib, a required dependency when compiling Pillow from source.", install ffmpeg or libjpeg with homebrew (brew install ffmpeg or brew install libjpeg). Then try to install dsp-metadata-gui again. This fix was found on: GitHub.

If you encounter any further issues, do not hesitate to get in touch or open a GitHub issue.