Restructure docs.trr379.de #13

Merged
j.goddard merged 18 commits from restructure into main 2026-08-06 10:51:06 +00:00
92 changed files with 622 additions and 490 deletions

View file

@ -1,9 +1,16 @@
---
archetype: "home"
title: "Howto TRR379"
title: "How to TRR379"
---
The is the documentation site of the [Collaborative Research Center / Transregio
379: Neuropsychobiology of Aggression](https://www.trr379.de) ([TRR]({{% ref "/terms/trr" %}})379).
379: Neuropsychobiology of Aggression](https://www.trr379.de) ([TRR]({{% ref "/references/terms/trr" %}})379).
Select any topic from the menu or [search this site](search.html) for information.
Looking for something specific? One of these paths may help you find what you need:
- **I'm new to TRR379** or **This is my first time visiting these docs** >> [Getting Started]({{% ref "/start/" %}})
- **I want to know how to do a particular task** >> [Using TRR379]({{% ref "/howtos/" %}})
- **I'm a maintainer or administrator** >> [Advanced Usage & Admin]({{% ref "/advanced/" %}})
- **I need help** >> [Support]({{% ref "/support/" %}})

View file

@ -0,0 +1,8 @@
---
title: Advanced Usage & Admin
weight: 30
comment:
A place to collect specialized information that may require a more technical background for consortium administrators.
---
{{% children sort="weight" %}}

View file

@ -22,7 +22,7 @@ However, the service could also run under any other (existing) user account.
# new user, prohibit login, disable password
sudo adduser dumpthing --disabled-password --disabled-login
# allow this user to run prcoess while not logged in
# allow this user to run process while not logged in
sudo loginctl enable-linger dumpthing
# allow this user to execute systemd commands interactively.

View file

@ -39,7 +39,7 @@ NeuroBagel will be deployed under this user account, and all software and data w
# new user, prohibit login, disable password
sudo adduser neurobagel --disabled-password --disabled-login
# allow this user to run prcoess while not logged in
# allow this user to run process while not logged in
sudo loginctl enable-linger neurobagel
# allow this user to execute systemd commands interactively.

View file

@ -0,0 +1,45 @@
---
title: Edit the website
weight: 10
---
The [main TRR379 website]({{% ref "/references/services/main-website" %}}) is updated on a regular basis.
Much of the content, including contributor and publication lists, updates automatically whenever member submit information through the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}).
**Website updates should therefore happen through the metadata pooling system wherever possible.**
For those who need to edit the website directly (e.g., to add news items), the site is built with Hugo and stored as a DataLad dataset, meaning all changes are version-controlled.
The [repository README](https://hub.trr379.de/q04/www.trr379.de#readme) contains instruction on how to obtain a clone of the website for working on it, and testing it locally.
1. Clone the repository and then enter it:
`datalad clone https://hub.trr379.de/q04/www.trr379.de.git`
`cd www.trr379.de`
2. Download all content, including the theme:
`datalad get -r .`
3. Start the local preview server:
`hugo server`
4. After editing, push your changes:
`datalad push`
{{% notice style="important" %}}
**Image requirements:** All images must be added using DataLad (`datalad save -m "message"`) or git-annex (`git annex add <file>`), and never with a plain `git add`.
Page thumbnails should be a minimum of 320 by 240 pixels with an aspect ratio of 4:3.
{{% /notice %}}
5. **Alternatively:** {{% expand title="Make small edits directly on the collaboration hub." %}}
- The content of all pages can be browsed at https://hub.trr379.de/q04/www.trr379.de/src/branch/main/content.
- Each page provides an edit button (pencil icon) that enables editing content directly in the browser.
{{% /expand %}}
{{% notice style="note" %}}
Once a change has been submitted, it is not reflected on the website immediately.
All changes are reviewed and possibly adjusted by the website editor team of the [Q04]({{% ref "/references/resources/projects/q04/" %}}).
{{% /notice %}}

View file

Before

Width:  |  Height:  |  Size: 66 B

After

Width:  |  Height:  |  Size: 66 B

Before After
Before After

View file

@ -1,9 +1,9 @@
---
title: How to ...
title: Using TRR379 Tools
weight: 20
comment:
A place for manuals and guides that is visited by people that have
a concrete challenge and seek information.
---
{{% children sort="title" %}}
{{% children sort="weight" %}}

View file

@ -1,16 +1,16 @@
---
title: Submit annual DFG survey
title: Submit Annual DFG Survey
weight: 30
---
{{% notice style="primary" title="The 2025 survey is open!" icon="thumbs-up" %}}
{{% notice style="red" title="The 2025 survey is closed" icon="skull-crossbones" %}}
[Access the survey app](https://dfg-cp-survey.trr379.de) to participate.
{{% /notice %}}
{{% notice style="secondary" title="Need help?" icon="question" %}}
**_I am having issues with the survey form._**
If there are issues with the form, they can be submitted on the [TRR379 collaboration hub]({{% ref "/services/collaboration-platform" %}}) at https://hub.trr379.de/q02/dfg-cp-survey-ui/issues (requires an [account]({{% ref "/howtos/hub-account/" %}})), or emailed to [trr379@lists.fz-juelich.de](mailto:trr379@lists.fz-juelich.de?subject=TRR379%20DFG%20survey%20issue).
If there are issues with the form, they can be submitted on the [TRR379 collaboration hub]({{% ref "/references/services/collaboration-platform" %}}) at https://hub.trr379.de/q02/dfg-cp-survey-ui/issues (requires an [account]({{% ref "/start/accounts/#get-a-hub-account-and-log-in" %}})), or emailed to [trr379@lists.fz-juelich.de](mailto:trr379@lists.fz-juelich.de?subject=TRR379%20DFG%20survey%20issue).
**_I need a personalized access token._**
@ -19,7 +19,7 @@ As a member of the TRR379, you should receive an individual access token via ema
## Background
The Deutsche Forschungsgemeinschaft ([DFG]({{% ref "/terms/dfg" %}}), German Research Foundation) gathers information from its funded projects on an annual basis. Some information is collected from all members of a coordinated programme, such as a collaborative research centre ([CRC]({{% ref "/terms/crc" %}})).
The Deutsche Forschungsgemeinschaft ([DFG]({{% ref "/references/terms/dfg" %}}), German Research Foundation) gathers information from its funded projects on an annual basis. Some information is collected from all members of a coordinated programme, such as a collaborative research centre ([CRC]({{% ref "/references/terms/crc" %}})).
The data are used to produce statistical reports and provide answers to statistical queries. In addition, the data serve as the basis for statistical evaluations, which the DFG uses to comply with its reporting obligations to financial backers, the federal government and the state governments.
@ -27,7 +27,7 @@ For more information, please refer to the information on data protection in rela
## TRR379 approach
The TRR379 collects the DFG survey data using the same [infrastructure that is employed for research metadata collection and management]({{% ref "/services/knowledge-pooling" %}}), rather than the PDF-form based approach suggested by the DFG.
The TRR379 collects the DFG survey data using the same [infrastructure that is employed for research metadata collection and management]({{% ref "/references/services/knowledge-pooling" %}}), rather than the PDF-form based approach suggested by the DFG.
This offers the following advantages:
@ -35,7 +35,7 @@ This offers the following advantages:
- members can consent to having a subset of their information be used to create and update a profile page on their person on the TRR379 website with no additional effort
- members can consent to having basic information (e.g., name, ORCID) on them be made available in other TRR379 services, for example for reporting publications, or data annotation, to avoid repeated, manual information entry
Collected information is submitted to a TRR379-dedicated virtual server hosted at Forschunsgzentrum Jülich (operated by the [Q02 project](https://trr379.de/projects/q02)) via an encrypted connection.
Collected information is submitted to a TRR379-dedicated virtual server hosted at Forschunsgzentrum Jülich (operated by the [Q02 project]({{% ref "/references/resources/projects/q02" %}}) via an encrypted connection.
Individual person records are only accessible via a personalized link with an individual access token.
Members receive this access information via email.

A note to the future: The linked PDF-form under the following paragraph ("This service is opt-in. ...") does not exist anymore and will need an update for the 2026 survey.

A note to the future: The linked PDF-form under the following paragraph ("This service is opt-in. ...") does not exist anymore and will need an update for the 2026 survey.

View file

@ -1 +0,0 @@
/annex/objects/MD5E-s15760--02ef45beea7a14bc99551b3abd03a28f.webp

Before

Width:  |  Height:  |  Size: 66 B

View file

@ -1,33 +0,0 @@
---
title: Get a Hub account and log in
weight: 10
---
For working with the [TRR379 collaboration platform]({{% ref
"/services/collaboration-platform" %}}) an account is required.
You can either request an account manually, or sign in using "GitLab Aachen" single Sign-On (SSO).
#### Single Sign-On using GitLab Aachen
In order to sign in with Gitlab-Aachen, visit the [TRR379 collaboration platform]({{% ref "/services/collaboration-platform" %}}) and click *Sign in with Gitlab-Aachen* on the login page.
Login using your preferred identity provider (i.e., GitHub or your affiliated organization via DFN-AAI SSO).
Follow the on-screen instructions to activate your account.
![Sign in screen for TRR379 collaboration hub, with the Sign in with Gitlab-Aachen button circled in red.](sign-in_gitlab_aachen.webp)
Make sure to visit the confirmation link that will be sent to the email address associated with the account.
Upon confirmation the account will be in a restricted state for security reasons.
It will allow for login, but will not give read or write access to any resources.
New accounts will then be assigned to the respective projects. To expedite the process, please email trr379@lists.fz-juelich.de with a list of resources you need read and/or write access too (i.e., the knowledge pool, the main website, data hosting).
#### Manual request
In order to obtain an account manually, please email trr379@lists.fz-juelich.de.
Please email from an institutional email, and CC the respective
TRR379 project lead. In the email, please mention any projects
and/or [organizations](https://hub.trr379.de/explore/organizations)
you require read or write access to.
Please note that a manual request will not allow for using your institutional single-sign-on (SSO).

View file

@ -1,17 +1,13 @@
---
title: Use the knowledge pooling tool
weight: 25
title: Submit to the Knowledge Pool
weight: 10
comment:
Guides for working with the knowledge pooling tool,
including setup, submission, and curation
Guides for working with the knowledge pooling tool's web UI,
including specific workflows
---
The [knowledge pooling tool]({{% ref "/services/knowledge-pooling" %}}) is a platform for collecting, curating, and sharing structured information about research activities, outputs, and contributors across TRR379 projects and institutions.
It includes:
The [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling" %}}) is a platform for collecting, curating, and sharing structured information about research activities, outputs, and contributors across TRR379 projects and institutions.
- A **web UI** for submitting, editing, and browsing records such as people, projects, and publications
- A **backend API** allowing scripts and applications to contribute or retrieve metadata
- **Token-based authentication** that integrates with Forgejo teams on the [collaboration platform]({{% ref "/services/collaboration-platform" %}}) to manage read and write permissions
The following workflows provide step-by-step guidance for submitting specific record types to the pool, but note that many of the steps are transferable to other record types:
{{% children sort="weight" %}}
The following workflows provide step-by-step guidance for working with the [knowledge pooling tool]({{% ref "/services/knowledge-pooling" %}}):
{{% children sort="title" %}}

View file

@ -0,0 +1 @@
/annex/objects/MD5E-s88964--ccaf45f1255804ac080d7e7b49c063e4.webp

After

Width:  |  Height:  |  Size: 66 B

View file

@ -0,0 +1,78 @@
---
title: Create your contributor profile
weight: 10
---
[TRR379 contributor profiles](https://www.trr379.de/contributors/) are automatically updated on the [main website]({{% ref "references/services/main-website/" %}}) based on the [knowledge pool]({{% ref "references/services/knowledge-pooling/" %}}).
Follow these steps to create and/or edit your own profile, including uploading a portrait photo.
1. Navigate to the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}).
2. {{% expand title="Enter your token in the pool."%}}
- Click the "Settings" (gear) button.
- Select the "TOKENS" tab, paste [your token]({{% ref "start/accounts/generate-token/" %}}), and click "SAVE".
{{% /expand %}}
3. Select the "Person" Data Type on the left side of the page.
4. Create a new record by clicking the `+` (plus) button, or edit an existing record by clicking the pencil icon.
![Screenshot showing the add- and edit-buttons for a person record](create-edit-person.webp)
5. To add a portrait photo, click the "Upload a depiction" Wizard button (person silhouette icon). Click the file attachment button (paperclip icon), and select the portrait image with your file browser. Wait for the green checkmark confirmation of a successful upload, and then click "SAVE".
{{% notice style="important" %}}
**Image requirements:**
- Contributor portraits: maximum 400 pixels wide
- Page thumbnails: minimum 320 by 240 pixels, aspect ratio 4:3
- A single image can serve as both portrait and thumbnail if the face is centered
{{% /notice %}}
6. Proceed to add relevant information to complete your contributor profile as follows:
{{% expand title="ORCID identifier"%}}
- Within the "Identifiers" box, select "ADD NEW ITEM" and then "ORCID" from the dropdown menu.
- Under "Notation", enter your ORCID in the format "XXXX-XXXX-XXXX-XXXX".
- Under "Creator", start typing "ORCID" and select the "ORCID" organization when it appears in the dropdown menu.
- Click "SAVE" in the top-right corner to save the ORCID record.
{{% /expand %}}
{{% expand title="Description"%}}
- Within the "Description" box, type a short biography, which can include (but is not limited to) information such as your affiliation(s), professional expertise/interests, and your role within TRR379.
- The "Description" field supports Markdown formatting. To preview how your description will render, select the small Markdown logo (capital "M" with a downward-facing arrow) to enter the Markdown editor.
{{% /expand %}}
{{% expand title="Name(s)"%}}
- Enter the relevant family name(s), given name(s), honorifics, etc. in the respective text boxes.
{{% /expand %}}
{{% expand title="Affiliation(s)"%}}
- Within the "Delegated by" box, select "Organization" from the dropdown menu.
- A new box will appear just below "Organization". Search for your affiliated organization by starting to type its name, and select the appropriate organization when it appears in the dropdown menu.
- **TIP:** Organizations might exist in the pool in a language different to what you are searching for, or might not be searchable based on their abbreviations. Try searching keywords in the organization name that do not translate in different languages before adding a new organization. For example, you may want to search "Jülich" *instead* of "Research Centre Jülich", "Forschungszentrum Jülich", or "FZJ".
- To add additional affiliations, select the `+` (plus) button to the right of the "Delegated by" boxes.
{{% /expand %}}
7. Once all relevant information has been entered, click "SAVE" in the top-right corner to save the Person record.
8. Click the "Submit" button (cloud icon, top-right), which should show a green notification dot to indicate changes are ready to be submitted.
{{% notice style="accent" title="Important note about saving versus submitting" icon="bolt" %}}
The pool has two separate actions: saving and submitting.
**Saving stores your work in the browser only!**
It does **not** *submit* the record to the server for use by the consortium workflows.
To submit, click the Submit button (cloud icon, top-right corner) when there is a green notification dot indicating records are ready for submission.
**Do not close your browser tab before submitting**, or your data will be lost.
{{% /notice %}}
9. The interface will list all records you are about to submit. For a contributor profile with a profile photo, you should see three records: a File, a Depiction, and a Person.
10. Click "Submit". A confirmation message will appear when submission is successful. If an error occurs, note the message and retry. If it persists, you may wish to review common error messages or reach out for help via the resources on the [Support]({{% ref "/support/" %}}) page.
![Screenshot showing the form submit button with a summary of the saved and to-be submitted records.](submit-person.webp)

View file

@ -0,0 +1 @@
/annex/objects/MD5E-s78548--ecdd616e653f58943fb23c421c8edaba.webp

After

Width:  |  Height:  |  Size: 66 B

View file

@ -1 +0,0 @@
/annex/objects/MD5E-s33758--f583beeba40153595cfbb3a492404b08.webp

Before

Width:  |  Height:  |  Size: 66 B

View file

@ -1 +0,0 @@
/annex/objects/MD5E-s100822--5e118770c92cab47a8495f712220c122.webp

Before

Width:  |  Height:  |  Size: 67 B

View file

@ -1 +0,0 @@
/annex/objects/MD5E-s96978--ecfc5e08c5da5380db6252e10569ac0f.webp

Before

Width:  |  Height:  |  Size: 66 B

View file

@ -1 +0,0 @@
/annex/objects/MD5E-s98794--7fa5dd3a36dbfe83833b94661d5e6236.webp

Before

Width:  |  Height:  |  Size: 66 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

View file

@ -1,112 +0,0 @@
---
title: General usage guide
weight: 20
---
This guide explains how to use the [knowledge pooling tool]({{% ref "/services/knowledge-pooling" %}})'s [`shacl-vue` web UI](https://pool.v0.trr379.de/ui/) and [`dump-things` API service](https://pool.v0.trr379.de/api/docs) to submit, edit, and review metadata records.
It applies to all record types, such as publications, personnel, projects, and topics.
For workflow-specific instructions (e.g., publication reporting), see the [Workflows]({{% ref "/howtos/pool-tool/workflows" %}}) section.
## Submit or edit a publication record using the web UI
The web UI for submitting, editing, and browsing records is provided at [https://pool.v0.trr379.de/](https://pool.v0.trr379.de/).
![Screenshot of https://pool.v0.trr379.de/. The page is titled, TRR379 Research Metadata System and subtitled, User interface and API for pooling information across project sites and consortium partners. The ACCESS LATEST EDITOR VERSION button is circled in red with a red arrow pointing to it. There is an About paragraph that describes the metadata pooling service as follows: This is the metadata pooling service of TRR379. It is designed to be used by consortium partners to report on data collections and other research activities, in order to communicate them to the consortium at large. Meta data records can be submitted by authorized users and automated processes. Records are stored on a secure server at Forschungszentrum Jülich. Individual record types are classified to either be publicly accessible, or to be available to particular users via authenticated requests only. The TRR379 Q02 project develops and operates this service. Underneath the About paragraph, is a Components section with three components: Editor, API, and Schema. The TRR379 logo is displayed at the top right of the screen.](knowledge-pooling-tool.webp)
{{% notice style="primary" title="Tip" icon="lightbulb" %}}
It is **highly recommended** to use this web UI with a desktop browser;
the form offers rich contextual information that is hard to access on mobile devices.
{{% /notice %}}
### Authenticate with your access token
Submitting publication records will only be possible using a valid [access token]({{% ref "/howtos/pool-tool/setup/index.md#generate-a-personal-access-token" %}})
The token can be entered via the Key button in the web UI.
![Screenshot showing token management button and pop-up window.](enter-token.webp)
### Create or edit a record
Records correspond to structured metadata entities (e.g., Person, Topic, Publication).
Each record is created and managed through a form defined by the [metadata schema](https://concepts.trr379.de/s/research-assets/unreleased/).
If no record on a given entity already exists, a new record must be created.
Click the `+` (plus) button next to the desired record type (e.g., Publication or Person).
![Screenshot showing the add-button for a publication record](create-record.webp)
Alternatively, if a previous record already exists, it can be loaded by clicking on the Edit button (pencil icon).
You can search for records by title/name, [identifier]({{% ref "/resources/identifier-concept" %}}), or other metadata attributes.
![Screenshot showing the edit-button for a publication record](edit-record.webp)
### Fill out record fields
Context help describing expected values and controlled vocabularies is provided for each field.
Hover your mouse pointer over the field label to display help text.
![Screenshot showing where to hover to access the context help](context-help.webp)
For some fields (e.g., authors or publication venue when filling out a publication record), one or more choices have to be selected.
The selector offers type-ahead search of choices.
The selection is contrained to choices matching the entered text in their label.
Select the appropriate value from the dropdown list.
![Screenshot showing the item selector and constrained search](selector.webp)
If no adequate choice exists, click *Add New Item* to create one.
{{% notice style="primary" title="Tips for Searching" icon="lightbulb" %}}
- Try entering full names instead of abbreviations
- If an item is not found in one language, try searching its English version
- Wait a few seconds for choices to populate before creating a new record; search results may take time to load.
{{% /notice %}}
### Save and submit records
Submitting metadata involves two different save actions: [local saves](#save-form-sections-local-save) and [submitting to the server](#submit-to-server).
#### Save form sections (local save)
{{% notice style="accent" title="Important" icon="bolt" %}}
**Saving only stores the information in the local browser session!**
It does not submit the record to the server to make it visible to curators.
{{% /notice %}}
Whenever a record (or sub-field) is completed, it must be saved by clicking the *Save* button.
**You must do this for each section you complete.**
Saving temporarily stores the record in your browser session.
![Screenshot showing the form save button](save-form.webp)
#### Submit to server
Once the record is complete and [saved locally](#save-form-sections-local-save), it can be submitted to the server by clicking the *Submit* button (cloud icon with up arrow), which will show a green indicator if changes have *not* yet been submitted to the server.
If you haven't already [entered your access token](#authenticate-with-your-access-token), the interface will prompt you to do so.
![Screenshot showing the form submit button, as well as the pop-up window prompting the user to enter their access token.](submit-form.webp)
The interface will provide you with an overview of the changes you are about to submit.
![Screenshot showing the form submit button with a summary of the saved and to-be submitted record.](submit-overview.webp)
#### Possible errors
**Authorization issues**
If the [access token]({{% ref "/howtos/pool-tool/setup/index.md#generate-a-personal-access-token" %}}) you are providing is incorrect or does not have appropriate permissions, the interface will display an error like this during metadata retrieval or submission:
![Screenshot of the token prompt displaying an "invalid token" message](invalid-token.webp)
**Incomplete information**
If a metadata record is missing required information, you will not be able to save it.
Required fields - highlighted with a red asterix - and an warning sign will alert you to this.
![Screenshot of an empty publication record form with missing required fields highlighted.](incomplete-form.webp)
**Internal errors**
If there is an unexpected error during metadata submission, the submission interface will report technical information.
Please contact m.hanke@fz-juelich.de and copy the entire error message.
![Screenshot of the submission interface reporting an error](submit-error.webp)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

View file

@ -1 +0,0 @@
/annex/objects/MD5E-s95258--34aefbd7b03b40c856a0ed28a1b2c0bb.webp

Before

Width:  |  Height:  |  Size: 66 B

View file

@ -1 +0,0 @@
/annex/objects/MD5E-s52664--afbeb5b11d1ac70c19c00a03c9616705.webp

Before

Width:  |  Height:  |  Size: 66 B

View file

@ -1 +0,0 @@
/annex/objects/MD5E-s32264--4ed77c6c3b0668cbc44efe027ee4817e.webp

Before

Width:  |  Height:  |  Size: 66 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

View file

@ -1 +0,0 @@
/annex/objects/MD5E-s89036--258f58742b4df4b69f9e1d6d2068abae.webp

Before

Width:  |  Height:  |  Size: 66 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

View file

@ -0,0 +1 @@
/annex/objects/MD5E-s86580--a0f43cfa61172dfb807116bfa44833b3.webp

After

Width:  |  Height:  |  Size: 66 B

View file

@ -0,0 +1 @@
/annex/objects/MD5E-s63808--a5a611d02c5ae3c11ee67443188c379c.webp

After

Width:  |  Height:  |  Size: 66 B

View file

@ -0,0 +1 @@
/annex/objects/MD5E-s85604--4198490e1feac78d64d882d13b87e398.webp

After

Width:  |  Height:  |  Size: 66 B

View file

@ -0,0 +1,99 @@
---
title: Report publications
weight: 20
---
{{% notice style="note" %}}
Every member is responsible for submitting their own publications. Do not wait for someone else to add your work. If a publication is not in the pool, it will not appear in the consortium publication overview on the website.
{{% /notice %}}
1. Navigate to the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}).
2. {{% expand title="Enter your token in the pool."%}}
- Click the "Settings" (gear) button.
- Select the "TOKENS" tab, paste [your token]({{% ref "start/accounts/generate-token/" %}}), and click "SAVE".
{{% /expand %}}
3. Select the "Publication" Data Type on the left side of the page.
4. Select the "Import a publication via DOI" button (square icon with right-facing arrow, just to the right of the `+` plus button).
![Screenshot showing the button for importing a publication via its DOI](import-publication.webp)
5. Enter the DOI, and select "IMPORT". A new section should appear showing the imported metadata. If you receive an error message that the record already exists, follow the instructions to edit the existing record instead of importing a new one.
{{% notice style="note" %}}
Enter just the DOI without the URL part (i.e., `10.1016/j.neubiorev.2025.106386` and not `https://doi.org/10.1016/j.neubiorev.2025.106386`)
{{% /notice %}}
6. Confirm, add, or edit the Title, Abstract, and Authors as necessary. For authors that are not automatically linked upon import to Person records in the pool, you can click and search directly in the "Linked Record" column to find a corresponding Person record in the pool; if no linked record is selected, a new Person record will be created for that author. Click "SAVE" when everything looks correct.
![Screenshot showing the Imported metadata panel while selecting a Linked Record for a co-author](import-publication-metadata.webp)
7. Navigate to your new Publication record in the pool's Publication records list, and click the pencil icon to edit it.
![Screenshot highlighting the edit button to edit an existing Publication record](edit-publication.webp)
8. For publications to make the best impressions and live up to their fullest metadata potential, proceed to add relevant information to complete the Publication record as follows:
{{% expand title="Publication type"%}}
- Within the "Publication type" box, select the appropriate type (e.g., "Academic article") from the dropdown menu.
{{% /expand %}}
{{% expand title="Topic(s)"%}}
- Within the "Topic(s)" box, browse and select topics relevant to the publication from the dropdown menu.
- To add additional topics, select the `+` (plus) button to the right of the "Topic(s)" box.
{{% /expand %}}
{{% expand title="Publication journal and date"%}}
- Within the "Generated by" box, select "Activity" from the dropdown menu.
- A new box will appear just below "Activity". Select "Publishing process" from the dropdown menu.
- Click the pencil icon to add qualifying information (i.e., publication time and location).
- Add the publication date to the "At time" box in the format, YYYY-MM-DD. Alternatively, you can click the calendar icon to select the date.
- Add the publication venue/journal by searching its name within the "At location" box, and selecting the correct name when it appears in the dropdown menu. Alternatively, you can search the journal's ISSN. Wait a few seconds for choices to populate before creating a new record; search results may take time to load.
- Click "SAVE" in the top-right corner to save the publication journal and date information.
{{% /expand %}}
{{% expand title="Associated project(s)"%}}
- Within the "Generated by" box, select "Project" from the dropdown menu.
- A new box will appear just below "Project". Browse and select a TRR379 project associated with the publication from the dropdown menu.
- To add additional projects, select the `+` (plus) button to the right of the "Generated by" box.
{{% /expand %}}
{{% expand title="License" %}}
- If the publication has a particular license (e.g., within the Creative Commons suite), select the appropriate license from the dropdown menu within the "Rules" box.
{{% /expand %}}
{{% expand title="Funding acknowledgment" %}}
- At the very bottom of your Publication record editing screen, toggle the "All fields" option to on (indicated in blue).
- Within the "Annotations" box, search "TRR funding" and select whether TRR funding is or is NOT acknowledged in the publication.
{{% /expand %}}
9. Once all relevant information has been entered, click "SAVE" in the top-right corner to save the Publication record. After saving, a well-curated publication record links to its authors, topics, and projects.
10. Click the "Submit" button (cloud icon, top-right), which should show a green notification dot to indicate changes are ready to be submitted.
![Screenshot showing an annotated Publication record and highlighting the submission button](submit-publication.webp)
{{% notice style="accent" title="Important note about saving versus submitting" icon="bolt" %}}
The pool has two separate actions: saving and submitting.
**Saving stores your work in the browser only!**
It does **not** *submit* the record to the server for use by the consortium workflows.
To submit, click the Submit button (cloud icon, top-right corner) when there is a green notification dot indicating records are ready for submission.
**Do not close your browser tab before submitting**, or your data will be lost.
{{% /notice %}}
9. The interface will list all records you are about to submit. You should see your Publication record here.
10. Click "Submit". A confirmation message will appear when submission is successful. If an error occurs, note the message and retry. If it persists, you may wish to review common error messages or reach out for help via the resources on the [Support]({{% ref "/support/" %}}) page.

View file

@ -0,0 +1 @@
/annex/objects/MD5E-s74936--10b4b35a273156b3d947c887d0187f8f.webp

After

Width:  |  Height:  |  Size: 66 B

View file

@ -1 +0,0 @@
/annex/objects/MD5E-s32482--4ec0fa72519c1fd90c2833d3fa5b6518.webp

Before

Width:  |  Height:  |  Size: 66 B

View file

@ -1,79 +0,0 @@
---
title: Setup
weight: 10
---
This guide explains how to get started with the [knowledge pooling tool]({{% ref "/services/knowledge-pooling" %}}), including how to access the system, authenticate as a contributor, and prepare for submitting or curating records.
The focus of these steps differ depending on your role:
- **[Contributors/Submitters](#setup-for-general-contributors-and-submitters):** Setup access to submit and view records
- **[Managers/Administrators](#setup-for-managers-and-administrators):** Configure authentication and permissions
## Overview of access and authentication
Access to the [knowledge pooling tool]({{% ref "/services/knowledge-pooling" %}}) is managed using **tokens** and **Forgejo teams**.
Forgejo-based authentication ensures that permissions are linked to existing institutional or project accounts.
Tokens are used to identify users with interacting with the API or web UI.
Each user can hold different roles, such as:
- **Submitter:** Can create and modify records in their personal "inbox".
- **Curator:** Can view, edit, and approve submitted records.
- **Manager:** Can configure access settings and team memberships.
## Setup for general contributors and submitters
### Collaboration hub access and permissions
To report and access records using the [knowledge pooling tool]({{% ref "/services/knowledge-pooling" %}}), you must have read and write access to the `protected` collection of the pooling tool on the [TRR379 collaboration platform]({{% ref "/services/collaboration-platform" %}}).
You must be a member of both:
- [metadata-pool-read-protected](https://hub.trr379.de/org/q02/teams/metadata-pool-read-protected), and
- [metadata-pool-write-protected](https://hub.trr379.de/org/q02/teams/metadata-pool-write-protected).
To confirm your team memberships, first sign into the [TRR379 collaboration platform]({{% ref "/services/collaboration-platform" %}}) (see also [How to get a Hub account and log in]({{% ref "/howtos/hub-account" %}})), then click the links above to see the team members.
If you are unable to see the repository, team member list, or if your username is not listed, see below how to request access.
Otherwise, proceed to [generate a personal access token](#generate-a-personal-access-token).
#### Request access to `protected` team(s)
If you are *not* yet a member of the [metadata-pool-read-protected](https://hub.trr379.de/org/q02/teams/metadata-pool-read-protected) and/or [metadata-pool-write-protected](https://hub.trr379.de/org/q02/teams/metadata-pool-write-protected) team(s), please email [trr379@lists.fz-juelich.de](mailto:trr379@lists.fz-juelich.de?subject=Metadata%20pool%20protected%20teams) with a request to be added.
Please send the email from an institutional email with the respective TRR379 project lead in CC.
### Generate a personal access token
Reading and writing records into the [knowledge pooling tool]({{% ref "/services/knowledge-pooling" %}}) requires a token linked to your Forgejo account.
#### Create a new token
From your [collaboration platform]({{% ref "/services/collaboration-platform" %}}) account, navigate to *[Profile and settings > Settings > Applications > Generate new token](https://hub.trr379.de/user/settings/applications)*.
Name the token, choose *All* for the repository and organization access, and click *Select permissions* to list further permissions; the token needs to have `user:Read` and `organization:Read` permissions. Click *Generate token* once all permissions are set.
![User settings screen display for generating a token to grant access to your account using the Forgejo API. The Token name dump-things has been given. All (public, private, and limited) is selected for Repository and Organization Access. The remaining options are defined as follows: activitypub:No access, issue:No access, misc:No access, notification:No access, organization:Read, package:No access, repository:No access, user:Read. An orange Generate token button shows at the bottom.](generate-token.webp)
Copy the generated value and store your token securely;
it will be used to authenticate your submission through the web UI and in API calls.
{{% notice style="accent" title="Important" icon="bolt" %}}
Treat your token like a password. Do *not* share it publicly.
{{% /notice %}}
#### Test your token
You can verify that your token works using a simple API request:
```
curl 'https://pool.v0.trr379.de/api/protected/records/Thing' -H "x-dumpthings-token:<your-token-here>"
```
If the token is valid, this command will return a (potentially empty) list of entries.
If the token is invalid, it will return an `invalid token` error, together with helpful information what may be wrong (e.g., wrong scopes).
Once your token is working and you have confirmed your access, you can proceed to the [general usage guide]({{% ref "/howtos/pool-tool/general-usage" %}}) and [relevant workflows]({{% ref "/howtos/pool-tool/workflows" %}}) for instructions on how to enter or retrieve research metadata and outputs through the [knowledge pooling tool]({{% ref "/services/knowledge-pooling" %}}).
## Setup for managers and administrators
This section will describe how to configure the [knowledge pooling tool]({{% ref "/services/knowledge-pooling" %}}) from a management perspective, including:
- Defining **collections** (e.g., `protected`) and configuring the backend API (see also the [Dump Things Service documentation](https://github.com/christian-monch/dump-things-server/blob/master/README.md))
- Setting up and linking **Forgejo teams** for read and write access

View file

@ -1,13 +0,0 @@
---
title: Workflows
weight: 30
---
The TRR379 [knowledge pooling tool]({{% ref "/services/knowledge-pooling" %}}) supports several metadata-driven workflows to collect and curate research information.
Each workflow describes how contributors can create, edit, and/or review records for a specific type of research output or activity.
Before starting a workflow, see the [setup]({{% ref "/howtos/pool-tool/setup" %}}) and [general usage]({{% ref "/howtos/pool-tool/general-usage" %}}) guides for instructions on accessing the tool and working with the web interface and backend API.
Use the links below to learn more about individual workflows:
{{% children sort="title" %}}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.5 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

View file

@ -1,35 +0,0 @@
---
title: Publication reporting
---
The publication reporting workflow enables TRR379 members to register and curate metadata for publications associated with the consortium.
This workflow ensures research outputs are accurately linked to relevant projects, topics, and contributors.
Each submission includes contributor role assignments (e.g., author, senior author, etc.) to reflect the specific involvement of TRR379 members and collaborators.
In order to report a new publication, visit the [knowledge pooling tool]({{% ref "/services/knowledge-pooling" %}}) and select "Publication" as a data type from the left side of the page.
Add a new publication by clicking the "plus" sign, or modify an existing record using its pencil icon.
![Screenshot of the Publication page of the knowledge pooling tool](add-publication.webp)
For publications to make the best impressions and live up to their fullest metadata potential, fill out the required and applicable optional fields.
Where possible, the form lets you search through existing records, for example to easily link journals, authors, TRR topics, or projects.
![Screenshot of the Journal search](search-journal.webp)
![Screenshot of the search listing available TRR topics](search-topics.webp)
For fine-grained information, also select the contribution role a given co-author played - for example corresponding author or data manager.
![Screenshots of a list of authors of a publication, with their contribution roles defined.](contribution-roles.webp)
If non-TRR members authored or co-authored a publication, you can create new person records for these contributors.
While TRR members can select trr-related prefixes for their persistent identifiers, external contributors can be identified persistently using, e.g., their ORCID.
![Screenshot of the addition of a non-TRR member. The persistent identifier prefix is ORCID.](add-external-person.webp)
After saving, a well-curated publication record links to its authors, topics, and projects:
![Screenshot of the Publication page with a saved by unsubmitted new publication record.](publication-example.webp)
Finally, submit the added or edited records using the "submit" button.
![Screenshot of the Publication page, with the submission icon indication saved records that can be submitted.](submit-publication.webp)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1,023 KiB

View file

@ -1,25 +0,0 @@
---
title: Edit the website
weight: 20
---
The [main TRR379 website]({{% ref "/services/main-website" %}}) is automatically rendered with [Hugo](https://gohugo.io).
The website sources are hosted on the [TRR379 collaboration hub]({{% ref "services/collaboration-platform/" %}}) in a [repository under the Q04 project organization](https://hub.trr379.de/q04/www.trr379.de).
This repository is a [DataLad](https://datalad.org) dataset, the same technology that is used for research data management in the TRR379.
The [repository README](https://hub.trr379.de/q04/www.trr379.de#readme) contains
instruction on how to obtain a clone of the website for working on it, and testing
it locally.
**Alternatively**, small edits can be done on the collaboration hub directly.
The content of all pages can be browsed at https://hub.trr379.de/q04/www.trr379.de/src/branch/main/content.
Each page provides an "edit button" that enables editing content directly in the browser.
The following screenshot show this button for the source file of the [personal profile of Michael Hanke](https://www.trr379.de/contributors/michael-hanke/).
![Screenshot of a Forgejo page edit button](page_edit.webp)
Once a change has been submitted, it is not reflected on the website immediately.
All changes are reviewed and possibly adjusted by the website editor team of the
[Q04 project](https://www.trr379.de/projects/q04).

View file

@ -1,6 +1,6 @@
---
title: Work with raw MRI data
weight: 2000
weight: 20
comment:
Guides for working with DICOMs; archival and conversion.
---

View file

@ -1,45 +0,0 @@
---
title: Archive DICOMs
---
As the "true" raw data, DICOMs are rarely (re)accessed and hardly ever need to change.
However, they need to be stored somewhere.
Tracking DICOMs in DataLad datasets allows dependency tracking for conversion to NIfTI.
However, it's good to keep DataLad optional (allow DataLad and non-DataLad access).
## Historical precedent: ICF at FZJ
The following solution has been proposed for the Imaging Core Facility at FZJ:
- DICOMs are packed into tar files (tarballs) [^1]
- the tarballs are placed on a web server (intranet only), organized
by project (HTTP Basic Authentication for access management)
- DataLad datasets record availability via
[archivist](https://docs.datalad.org/projects/next/en/latest/generated/datalad_next.annexremotes.archivist.html)
and
[uncurl](https://docs.datalad.org/projects/next/en/latest/generated/datalad_next.annexremotes.uncurl.html)
special remotes, which translates to:
- a file is available from a tarball (archivist special remote)
- a tarball is available from a given URL, pointing to the web server (uncurl special remote)[^2].
- Only the Git repository (no annex) is stored by the consuming institute;
the ICF web server is the permanent DICOM storage.
The system has been documented in https://inm-icf-utilities.readthedocs.io/en/latest/
and the tarball & dataset generation tools implementation is in https://github.com/psychoinformatics-de/inm-icf-utilities.
[^1]: timestamps are normalized to ensure re-packing the same data does not change tarball checksums
[^2]: uncurl is chosen because it allows re-writing patterns with just configuration, e.g., should the base URL change
## TRR reimplementation
One of the TRR sites indicated intent to use a Forgejo instance for DICOM storage.
A particular challenge for the underlying system was [inode](https://en.wikipedia.org/wiki/Inode) limitation.
For this reason, an adaptation of the ICF system has been proposed:
- a dataset is generated upfront, and DICOM tarball is stored with the dataset in Forgejo (as annex)
- we keep using the archivist remote (file in tarball) to avoid using up thousands of inodes for individual files
(Git can pack its repository into several files, so we only add one more for the tarball).
A proof of principle for dataset generation (using re-written ICF
code) has been proposed in https://hub.trr379.de/q02/dicom-utilities. See the README for more
detailed explanations (and commit messages for even more detail).

View file

@ -7,78 +7,38 @@ It readies the data for processing with established pipelines, and applies a pse
TRR379 uses the [Brain Imaging Data Structure](bids.neuroimaging.io) (BIDS) as the standard for its datasets.
## Conversion to BIDS
The conversion of raw MRI data in DICOM format to a BIDS-compliant dataset is a largely automated process.
The recommended software to be used for conversion is [Heudiconv](https://heudiconv.readthedocs.io).
The recommended software to be used for conversion is [heudiconv](https://heudiconv.readthedocs.io).
Heudiconv uses [dcm2niix](https://github.com/rordenlab/dcm2niix) as the actual DICOM→NIfTI converter.
In our experience, `dcm2niix` is the most robust and most correct tool available for this task.
[Heudiconv tutorials](https://heudiconv.readthedocs.io/en/latest/tutorials.html) further illustrate how the software works.
Heudiconv does the job of mapping DICOM series to BIDS entities (ie. determine BIDS-compliant file names).
A key heudiconv concept is a **heuristic**: a Python program (function) which looks at the DICOM series properties and matches it with a file naming pattern.
Heudiconv performs the task of mapping DICOM series to BIDS entities (ie. determining BIDS-compliant file names).
A key heudiconv concept is a **heuristic**: a Python program (function) which receives the DICOM series properties and matches them with a file naming pattern.
A heuristic typically relies on DICOM series naming (set at the scanner console), but it can also use other properties such as number of images or acquisition parameters.
Because TRR379 uses its own conventions, a matching heuristic needs to be provided (possibly one for each TRR379 site).
An [implementation of such a heuristic](https://hub.trr379.de/q02/phantom-mri-bids/src/branch/main/code/heuristic-q01.py) has been created, and was tested on phantom MRI acquisitions from all sites (see below).
Using this heuristic, MRI data from all sites can be BIDS-standardized.
As with any automation, caution and oversight is needed for edge cases (e.g. repeated / discarded acquisitions).
Heudiconv workflows have been implemented at each MRI acquisition site, and reuse shared components.
[Heudiconv tutorials](https://heudiconv.readthedocs.io/en/latest/tutorials.html) further illustrate the process and capabilities of the software.
## Shared Resources
### Good practices
- [q02/heudiconv-container](https://hub.trr379.de/q02/heudiconv-container) is a DataLad dataset providing a heudiconv container.
- [q02/rdmtools](https://hub.trr379.de/q02/rdmtools) contains Python scripts which further automate BIDS conversion, pushing created datasets to dedicated locations, and other data curation tasks.
- [q01/phantom-mri-dicoms](https://hub.trr379.de/q01/phantom-mri-dicoms) is a superdataset grouping phantom MRI scans from all sites, used to develop and test the conversion workflow; it also contains the [reference TRR379 heudiconv heuristic](https://hub.trr379.de/q01/phantom-mri-dicoms/src/branch/main/code/heuristic-q01.py).
- Use heudiconv as a containerized application. Q02 provides a [readily usable utility dataset with a
configured container](https://hub.trr379.de/q02/heudiconv-container). See that repository for
an example usage.
- DICOMs as subdatasets helps with provenance, even if those DICOMs are never accessed outside
- Heudiconv takes paths and (optionally) intended subject IDs as input
- if paths contain identifying information, this would leak into DataLad run records
- having a helper script / lookup table in the (private) DICOM dataset can hide this information
> [!important]
> Each site maintains *its own copy of the heuristic* (as part of the site-specific DICOM superdataset) to account for site-specific differences.
### Caveats
## Details
- https://hub.trr379.de/q02/phantom-mri-bids used dcm2niix v1.0.20240202
- current latest is v1.0.20250506
- potential impact discussed in https://hub.trr379.de/q02/phantom-mri-bids/issues/8
### Modular datasets
## Demonstrators and resources
A DataLad dataset containing a BIDS dataset will typically have these subdatasets.
Subdatasets help in recording provenance while enabling different access scopes for different components:
### TRR phantom DICOMs
Scans of MRI phantoms were carried out using the intended sequences (presumably - see caveats section below).
These were shared with Q02 and uploaded to the TRR Hub forgejo instance:
- https://hub.trr379.de/q01/phantom-mri-dicom-aachen
- https://hub.trr379.de/q01/phantom-mri-dicom-frankfurt
- https://hub.trr379.de/q01/phantom-mri-dicom-heidelberg
- https://hub.trr379.de/q01/phantom-mri-dicom-mannheim
Note: Aachen did a re-scan which was shared by e-mail / cloud (June 03, 2025).
This has not been uploaded to forgejo (permissions + size).
### TRR phantom BIDS
- A BIDS-compliant dataset from these dicoms (3/4 sites): https://hub.trr379.de/q02/phantom-mri-bids
- The heuristic used: https://hub.trr379.de/q02/phantom-mri-bids/src/branch/main/code/heuristic-q01.py
- Issue tracker: https://hub.trr379.de/q02/phantom-mri-bids/issues
Conversion of re-scanned Aachen phantom is in https://hub.trr379.de/q02/tmp-phantom-bids (separate from the above
because input data is not available as a DataLad dataset)
### Data consistency
- the phantom datasets are not the same: https://hub.trr379.de/q02/phantom-mri-bids/issues/6
- re-scan from Aachen has more sequences than the initial scan, but lacks T2w
- heudiconv fails to parse some Heidelberg dicoms, and dcm2niix raises warnings;
unclear whether this is data issue or software issue: https://hub.trr379.de/q02/phantom-mri-bids/issues/5
### Conversion: technical issues
These are open questions:
- Technical: BIDS validator errors https://hub.trr379.de/q02/phantom-mri-bids/issues/7
- Technical: re-run with the latest dcm2niix https://hub.trr379.de/q02/phantom-mri-bids/issues/8
- `code/heudiconv`: heudiconv container ([q02/heudiconv-container](https://hub.trr379.de/q02/heudiconv-container))
- `code/rdmtools`: optional, shared scripts for data curation tasks ([q02/rdmtools](https://hub.trr379.de/q02/rdmtools))
- `sourcedata/dicoms`: a site-specific DICOM dataset, itself containing one subdataset per session
- `.heudiconv`: heudiconv cache / intermediate outputs are stored in a separate dataset to avoid including DICOM information in the BIDS dataset

View file

@ -0,0 +1,8 @@
---
title: References
weight: 60
comment:
A place to collect resources that consortium members may reference often to provide more detailed or explanatory information on various topics.
---
{{% children sort="weight" %}}

View file

@ -1,6 +1,6 @@
---
title: Goals
weight: 40
weight: 10
comment:
A place to put aspirational content in order to communicate a vision,
and to help contributors push towards these goals.

View file

@ -6,7 +6,7 @@ mermaidZoom: true
**[This is a draft under discussion]**
The planned RDM infrastructure is a federation of interoperable site
The planned [RDM]({{% ref "/references/terms/rdm/" %}}) infrastructure is a federation of interoperable site
infrastructures. The key design principle is that *no primary data are
aggregated to a central infrastructure*.
@ -148,13 +148,13 @@ of TRR379.
Sites are free to implement any RDM solutions, as long as that infrastructure
provides
- (programmatically) queriable metadata of a previously agreed upon nature
- (programmatically) queryable metadata of a previously agreed upon nature
- (programmatically) accessible data to any authorized members of TRR379
with the aim to enable reproducible research from primary data to published
results within and across TRR379.
[Q02](https://www.trr379.de/projects/q02) supports sites with software solution
[Q02]({{% ref "/references/resources/projects/q02" %}}) supports sites with software solution
that facilitate interoperability within TRR379. This includes the local
deployment of the software systems used to run the central services.

View file

@ -1,6 +1,6 @@
---
title: Identifier concept
weight: 10
title: Identifier Concept
weight: 30
---
Identifiers are an essential component of the TRR379 research data management (RDM) approach.

View file

@ -3,11 +3,11 @@ title: Participants
weight: 10
---
This page is a more in-depth description of the rationale behind the [SOP]({{% ref "/terms/sop" %}}) for participant identifiers used by TRR379.
This page is a more in-depth description of the rationale behind the [SOP]({{% ref "/references/terms/sop" %}}) for participant identifiers used by TRR379.
## Q1 participant identifiers
[Q01](https://www.trr379.de/projects/q01) is the central recruitment project.
[Q01]({{% ref "/references/resources/projects/q01" %}}) is the central recruitment project.
Any participant included in the core TRR379 dataset is registered with Q01 and receives an identifier.
This identifier is unique within TRR379 and stable across the entire lifespan of TRR379.

View file

@ -1,9 +1,9 @@
---
title: Resources
weight: 20
weight: 40
comment:
A place for materials that are useful to link to in more than one
context (for example, from multiple howtos).
---
{{% children sort="title" %}}
{{% children sort="weight" %}}

View file

@ -0,0 +1,6 @@
---
title: Service Projects
weight: 10
---
{{% children sort="title" %}}

View file

@ -0,0 +1,6 @@
---
title: Q01
weight: 10
---
[Q01](https://www.trr379.de/projects/q01) is the central recruitment project responsible for collecting and curating TRR379's longitudinal dataset.

View file

@ -0,0 +1,6 @@
---
title: Q02
weight: 20
---
The [Q02](https://www.trr379.de/projects/q02/) project operates a network of [RDM]({{% ref "/references/terms/rdm/" %}})-related services supporting the TRR379.

View file

@ -0,0 +1,6 @@
---
title: Q03
weight: 30
---
The [Q03](https://www.trr379.de/projects/q03/) project integrates training and mentoring activities into a research training group (RTG).

View file

@ -0,0 +1,6 @@
---
title: Q04
weight: 40
---
The [Q04](https://www.trr379.de/projects/q04/) project coordinates governance for the TRR379 consortium as well as communication among participating researchers and the public.

View file

@ -1,12 +1,12 @@
---
title: Services
weight: 10
weight: 20
comment:
A place for descriptions of services that are available to consortium
members for pursuing to goals of the collaboration.
---
The [Q02 project](https://trr379.de/projects/q02) operates a network of RDM-related services supporting the TRR379. They are described in more detail in the following sections.
The [Q02 project]() operates a network of RDM-related services supporting the TRR379. They are described in more detail in the following sections.
{{% children sort="weight" %}}
@ -15,7 +15,7 @@ graph TB;
subgraph Central services
C1[("Collaboration portal<br>hub.trr379.de<br> 🔐")]
C2{{"Cohort search<br>nb-query.trr379.de<br> 🔐"}}
C3(Main website<br>www.trr379.de)
C3("Main website<br>www.trr379.de")
C4("Data catalog<br>data.trr379.de")
C5[("Knowledge pool<br>pool.trr379.de<br> 🔐")]
C6("Documentation<br>docs.trr379.de")

View file

@ -1,6 +1,6 @@
---
title: Calendars
weight: 30
weight: 20
---
TRR379 uses a dedicated CalDAV server at https://cal.trr379.de. This service
@ -18,7 +18,7 @@ Contact the management team to request a dedicated calendar.
## Public calendars
All public calenders are available via CalDAV URL and can be included in any
All public calendars are available via CalDAV URL and can be included in any
calendar solution, such as Google calendar.
The URLs follow the pattern `https://cal.trr379.de/public/<name>`,
@ -26,7 +26,7 @@ where `<name>` is the calendar name, as stated in the list below. For the
events calendar this is `https://cal.trr379.de/public/events`.
For use with Google calendar, replace `https://` with `webcal://`. For example,
the events calendar can be added to Google calender with the URL
the events calendar can be added to Google calendar with the URL
`webcal://cal.trr379.de/public/events`.
Available public calendars:

View file

@ -1,9 +1,9 @@
---
title: Cohort data discovery
weight: 40
title: Cohort Data Discovery
weight: 70
---
https://nb-query.trr379.de hosts the central [NeuroBagel](https://neurobagel.org) query interface of the TRR379.
With this solution, data availability can be queried dynamically, to faciliate data access requests.
With this solution, data availability can be queried dynamically, to facilitate data access requests.
NeuroBagel supports federated queries and is therefore ideally suited for the decentralized research data management approach of TRR379.

View file

@ -1,6 +1,6 @@
---
title: Collaboration platform
weight: 20
title: Collaboration Platform
weight: 30
---
https://hub.trr379.de is the central (data) collaboration site of the consortium.
@ -12,4 +12,4 @@ The full software-stack is free and open source software, and can be deployed at
This aspect is essential for supporting the decentralized RDM approach of the TRR.
Any contributor can have an account on the central hub.
Please contact [Michael Hanke](https://www.trr379.de/contributors/michael-hanke/) to get set up.
Please [contact the Q02 team]({{% ref "/support/" %}}) to get set up.

View file

@ -1,6 +1,6 @@
---
title: Data catalog
weight: 30
title: Data Catalog
weight: 60
---
https://data.trr379.de hosts the data catalog of the TTR379. This site is
@ -8,6 +8,7 @@ currently work in progress, and will be published once the project
has started to accumulate data.
{{% include file="snippets/datalad/extensions/catalog/what-is-a-data-catalog.md" %}}
{{% include file="snippets/datalad/extensions/catalog/why-contribute-to-a-catalog.md" %}}
{{% include file="snippets/datalad/extensions/catalog/data-privacy.md" hidefirstheading=true %}}

View file

@ -1,6 +1,6 @@
---
title: Data models
weight: 50
title: Data Models
weight: 80
---
https://concepts.trr379.de hosts resources and documentation on the metadata models driving the research data management procedures of TRR379.

View file

@ -1,6 +1,6 @@
---
title: Documentation
weight: 100
weight: 90
---
https://docs.trr379.de (this site) is the main documentation source for the TRR379.

View file

@ -0,0 +1,27 @@
---
title: Knowledge Pooling Tool
weight: 40
---
The knowledge pooling tool is a system used for aggregating information on research progress and outputs across TRR379 partner sites and projects.
It comprises:
- A **web UI** for submitting, editing, and browsing records such as people, projects, and publications
- A **backend API** allowing scripts and applications to contribute or retrieve metadata
- **Token-based authentication** that integrates with Forgejo teams on the [collaboration platform]({{% ref "/references/services/collaboration-platform" %}}) to manage read and write permissions
The current (generation v0) tool can be accessed at:
- UI: https://pool.v0.trr379.de/ui/
- API: https://pool.v0.trr379.de/api/docs
For technical information on the knowledge pooling tool and its data and privacy policy, visit:
- https://pool.v0.trr379.de/
For information on using the knowledge pooling tool, see:
- [Accounts & Access]({{% ref "start/accounts/" %}}) for getting set up, including creating a linked [Hub]({{% ref "references/services/collaboration-platform/" %}}) account and a personal access token for authentication purposes
- [Submit to the Knowledge Pool]({{% ref "howtos/pool-tool/" %}}) for submitting, editing, and browsing records in the web UI
- [`shacl-vue` Documentation](https://shacl-vue.psychoinformatics.de/) (external link) for the documentation for the knowledge pool's web UI.
- [Dump Things Service Documentation](https://dump-things-service.readthedocs.io/en/latest/) (external link) for the documentation for the knowledge pool's backend API.

View file

@ -1,6 +1,6 @@
---
title: Main website
weight: 10
title: Main Website
weight: 50
---
[This](https://www.trr379.de) is the main website of the TRR379.
@ -16,6 +16,11 @@ function of TRR379. Such entities include
- site of the consortium
- ...
## Sources
The website sources are hosted on the [TRR379 collaboration hub]({{% ref "/references/services/collaboration-platform/" %}}) in a [repository under the Q04 project organization](https://hub.trr379.de/q04/www.trr379.de).
This repository is a [DataLad](https://datalad.org) dataset, the same technology that is used for research data management in the TRR379.
The [repository README](https://hub.trr379.de/q04/www.trr379.de#readme) contains instruction on how to obtain a clone of the website for working on it, and testing it locally.
## Semantics

View file

@ -0,0 +1,17 @@
---
title: Matrix Space
weight: 10
---
The TRR379 has a dedicated space at https://app.element.io/#/room/!YTyCzxGsutdlGNxjGj:matrix.org on [Matrix](https://matrix.org/), an open, free, and encrypted messaging platform with unlimited history.
It is intended as an informal place to exchange information, get faster feedback, and connect with people working on the same topics across sites.
Joining is entirely voluntary.
To join the space, you need a Matrix account.
Many institutions provide their own [homeservers](https://matrix.org/docs/matrix-concepts/elements-of-matrix/#homeserver) for setting up institutional accounts.
If not, anyone can create a free account at https://app.element.io/.
The TRR379 Matrix space is only for TRR379 consortium members.
To get access, email [trr379@lists.fz-juelich.de](mailto:trr379@lists.fz-juelich.de?subject=TRR379%20Matrix%20access) with your Matrix account name included, or contact @mih:matrix.org directly on matrix.

View file

@ -1,6 +1,6 @@
---
title: Service status monitor
weight: 5
title: Service Status Monitor
weight: 100
---
The website [status.trr379.de](https://status.trr379.de) provides a central

View file

@ -1,6 +1,6 @@
---
title: Glossary
weight: 1000
weight: 50
---
{{% children sort="title" %}}

View file

@ -0,0 +1,5 @@
---
title: RDM
---
Research data management (RDM) is the set of practices around handling research data throughout its lifecycle.

View file

@ -1,18 +0,0 @@
---
title: Knowledge pooling tool
weight: 35
---
The knowledge pooling tool is a system used for aggregating information on research progress and outputs across TRR379 partner sites and projects.
It comprises a web UI for manually submitting, editing, and browsing information, and an API for programmatic submission and retrieval.
The current (generation v0) tool can be accessed at:
- UI: https://pool.v0.trr379.de/ui/
- API: https://pool.v0.trr379.de/api/docs
For technical information on the knowledge pooling tool and its data and privacy policy, visit:
- https://pool.v0.trr379.de/
For information on using the knowledge pooling tool, see the [Use the knowledge pooling tool]({{% ref "howtos/pool-tool" %}}) How to pages.

8
content/start/_index.md Normal file
View file

@ -0,0 +1,8 @@
---
title: Getting Started
weight: 10
comment:
A place to give an overview of digital platforms of the consortium and how a consortium member can interact with them with little to no technical background.
---
{{% children sort="weight" %}}

View file

@ -0,0 +1,16 @@
---
title: Accounts & Access
weight: 10
---
The [TRR379 collaboration platform]({{% ref "/references/services/collaboration-platform/" %}}) (or "Hub" for short) is the platform for code and large dataset collaboration, and where access tokens for the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}) are generated.
The Hub runs an enhanced version of the [Forgejo](https://forgejo.org/) software.
Access to the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}) is managed using **tokens** and **Forgejo teams**.
Forgejo-based authentication ensures that permissions are linked to existing institutional or project accounts.
Tokens are used to identify users interacting with the API or web UI.
Only users with a valid access token can add or edit records.
Follow the guides below to create and configure your Hub account with appropriate permissions and generate an access token.
{{% children sort="weight" %}}

View file

@ -0,0 +1 @@
/annex/objects/MD5E-s24074--ad547b313c9594e38bc6b2234cbf5172.webp

After

Width:  |  Height:  |  Size: 66 B

View file

@ -0,0 +1,22 @@
---
title: Generate an access token on the Hub
weight: 30
---
1. Visit the [TRR379 collaboration hub]({{% ref "/references/services/collaboration-platform/" %}}) and log in with your credentials. If you do not have an account, see instructions on how to [get a Hub account and log in]({{% ref "/start/accounts/get-hub-account/" %}}) and to [configure your permissions]({{% ref "/start/accounts/permissions/" %}}).
2. Click your avatar in the top-right corner, and navigate to *[Settings > Applications](https://hub.trr379.de/user/settings/applications)*.
3. Under *Access tokens* click *New access token*, and fill in the form:
- Give the token a recognizable name (e.g., "Pool token")
- Choose `All` for *Repository and organization access*
- Under *Select permissions*, enable: `organization: Read`, `repository: Read and write`, and `user: Read`.
4. Click *Generate token*.
![User settings screen display for generating a token to grant access to your account using the Forgejo API. The Token name Pool token has been given. All (public, private, and limited) is selected for Repository and Organization Access. The remaining options are defined as follows: activitypub:No access, issue:No access, misc:No access, notification:No access, organization:Read, package:No access, repository:Read and write, user:Read. An orange Generate token button shows at the bottom.](generate-token.webp)
5. The token appears as a long string. **Copy the generated value immediately, and store it safely.** It disappears after refreshing.
{{% notice style="accent" title="Important" icon="bolt" %}}
Treat your token like a password; do **not** share it publicly. Once generated, the same token can be reused for all future sessions.
{{% /notice %}}

View file

@ -0,0 +1,29 @@
---
title: Get a Hub account and log in
weight: 10
---
An account is required for working with the [TRR379 collaboration platform]({{% ref "/references/services/collaboration-platform/" %}}) on Forgejo.
You can sign in using ["GitLab Aachen" Single Sign-On (SSO)](#single-sign-on-using-gitlab-aachen) (preferred) or [request an account manually](#manual-request).
### Single sign-on using GitLab Aachen
1. Visit the [TRR379 collaboration hub]({{% ref "/references/services/collaboration-platform/" %}}) and click *Sign in with Gitlab-Aachen* on the login page.
![Sign in screen for TRR379 collaboration hub, with the Sign in with Gitlab-Aachen button circled in red.](sign-in_gitlab_aachen.webp)
2. Log in using your preferred identity provider (i.e., GitHub or your affiliated organization via DFN-AAI SSO) and follow the on-screen instructions to activate your account.
j.goddard marked this conversation as resolved

Please add a statement like

If you are using a private account to register (github, google, ...). Please make sure to email trr379@lists.fz-juelich.de after you registered, explaining your institutional affiliation and relationship with TRR379. If anyhow possible, institutional emails/accounts shoud be used.

The underlying registeration ping/pong consumes a significant chunk of time admining the hub.

Please add a statement like > If you are using a private account to register (github, google, ...). Please make sure to email trr379@lists.fz-juelich.de after you registered, explaining your institutional affiliation and relationship with TRR379. If anyhow possible, institutional emails/accounts shoud be used. The underlying registeration ping/pong consumes a significant chunk of time admining the hub.
3. Visit the confirmation link that will be sent to the email address associated with the account.
{{% notice style="accent" title="Important" icon="bolt" %}}
If you are using a private account to register (e.g., GitHub, Google, etc.), **please email trr379@lists.fz-juelich.de after you registered**, explaining your institutional affiliation and relationship with TRR379.
If anyhow possible, institutional emails/accounts should be used.
{{% /notice %}}
### Manual request
In order to obtain an account manually, email trr379@lists.fz-juelich.de. Please email from an institutional email, and CC the respective TRR379 project lead. In the email, mention any projects and/or [organizations](https://hub.trr379.de/explore/organizations) you require read or write access to.
{{% notice style="note" %}}
A manual request will *not* allow for using your institutional Single Sign-On (SSO).
{{% /notice %}}

View file

Before

Width:  |  Height:  |  Size: 66 B

After

Width:  |  Height:  |  Size: 66 B

Before After
Before After

View file

@ -0,0 +1,23 @@
---
title: Set up your Hub account permissions
weight: 20
---
To access and report records using the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}), you must have read and write access to the `protected` collection on the [TRR379 collaboration platform]({{% ref "/references/services/collaboration-platform/" %}}).
You must be a member of both:
- [metadata-pool-read-protected](https://hub.trr379.de/org/q02/teams/metadata-pool-read-protected), and
- [metadata-pool-write-protected](https://hub.trr379.de/org/q02/teams/metadata-pool-write-protected).
1. To confirm your team memberships, sign into the [Hub]({{% ref "/references/services/collaboration-platform/" %}}) (see also [Get a Hub account and log in]({{% ref "/start/accounts/get-hub-account/" %}})).
2. Navigate to **both** of the following links to view the team members:
- [metadata-pool-read-protected](https://hub.trr379.de/org/q02/teams/metadata-pool-read-protected)
- [metadata-pool-write-protected](https://hub.trr379.de/org/q02/teams/metadata-pool-write-protected)
3. If you are unable to see a repository or team member list, or if your user name is not listed, please proceed to request access.
4. {{% expand title="Request access to protected team(s)" %}}
- Please email [trr379@lists.fz-juelich.de](mailto:trr379@lists.fz-juelich.de?subject=Metadata%20pool%20protected%20teams) from an institutional email and with the respective TRR379 project lead in CC to request access to the [metadata-pool-read-protected](https://hub.trr379.de/org/q02/teams/metadata-pool-read-protected) and/or [metadata-pool-write-protected](https://hub.trr379.de/org/q02/teams/metadata-pool-write-protected) team(s).
{{% /expand %}}

View file

@ -0,0 +1,26 @@
---
title: Communication Channels
weight: 20
---
This page provides an overview of how you can engage with the TRR379 community.
Follow the links below for details on each platform and how you can get set up.
### Stay updated
- The [**main website**]({{% ref "/references/services/main-website/" %}}) is the public face of the consortium and its canonical reference system. It is updated on a regular basis, and you should check it frequently for news, announcements, current project and contributor listings, and up-to-date publication overviews.
- [**Calendars**]({{% ref "/references/services/calendars/" %}}) (internal and public) are hosted on a dedicated CalDAV server.
- The [**@angry.brains Instagram**](https://www.instagram.com/angry.brains) account introduces the TRR379's research topics and creates an opportunity to engage with a broad audience.
### Exchange information and get feedback
- The [TRR379 space on **Matrix**]({{% ref "/references/services/matrix/" %}}) is an informal place to connect with other members, exchange information, and get faster feedback.
- The [**`all/status` repository**](https://hub.trr379.de/all/status/issues) on the [Hub]({{% ref "/references/services/collaboration-platform" %}}) is a place to collect all issues related to TRR379 data integration.
### Report research activity
- The [**knowledge pooling tool**]({{% ref "/references/services/knowledge-pooling/" %}}) is the central collection point for research activity across all TRR379 partner sites and projects. When you submit something here, it automatically flows into the consortium website, progress reports, and other outputs.
### Ask questions and get help
In addition to the [communication channels for knowledge sharing](#exchange-information-and-get-feedback) listed above, you can visit the [Support]({{% ref "/support/" %}}) section of the documentation site for more information on how to get help.

View file

@ -1,11 +1,15 @@
---
title: Fulfill RTG requirements
weight: 10
title: Fulfilling RTG Requirements
weight: 30
---
All PhD students funded by the TRR379 participate in its [Research Training Group](https://git-ce.rwth-aachen.de/trr379/area-z-projects/q03).
All PhD students funded by the TRR379 participate in its [Research Training Group]({{% ref "/references/resources/projects/q03/" %}}) (RTG).
This involves certain obligations, of which you can find an overview below:
This involves certain obligations, of which you can find an overview below.
{{% notice style="note" %}}
The following links require you to log in to the TRR379's [GitLab space for the RTG](https://git-ce.rwth-aachen.de/trr379/area-z-projects/q03).
{{% /notice %}}
###### Participation

47
content/support/_index.md Normal file
View file

@ -0,0 +1,47 @@
---
title: Support
weight: 50
comment:
A place to collect details on where consortium members can turn to get support.
---
The [Q02]({{% ref "/references/resources/projects/q02/" %}}) project is happy to assist with any questions about the consortium's digital infrastructure or related to research data management workflows.
Please feel free to use the following channels, depending on the problems you are encountering.
### DataLad resources
{{% include file="snippets/datalad/datalad-resources.md" %}}
### Knowledge pool tips and tricks
To assist with common issues you may encounter while working with the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}), we have compiled some [tips and common errors related to the pool]({{% ref "/support/pool-tips/" %}}).
### Matrix
The [TRR379 matrix space]({{% ref "/references/services/matrix/" %}}) is an informal chat platform to connect with other consortium members, ask questions, and exchange information.
### Office hours
#### TRR379-specific issues
There is an open office hour on research data management for TRR379 members to meet synchronously every other Monday at 13:00 CE(S)T.
To join:
- Visit the [RDM room](https://matrix.to/#/!NryrtxVkCEcgCoNGUh:matrix.org?via=matrix.org&via=inm7.de) in the [TRR379 matrix space]({{% ref "/references/services/matrix/" %}}) and click continue.
- The Jitsi meeting link is in the channel description (info icon {{% icon icon="circle-info" %}} in the top-right corner).
#### DataLad (and beyond)
{{% include file="snippets/datalad/office-hours.md" %}}
### Hub issues
For specific problems and requests, opening a new issue in the appropriate repository on the [TRR379 Hub]({{% ref "/references/services/collaboration-platform/" %}}) is the best way to create a recorded history, particularly when lengthier discussions and/or multiple viewpoints might be necessary.
In particular, the [`all/status` repository's issue tracker](https://hub.trr379.de/all/status/issues) is a good place to report issues.
### E-mail
trr379@lists.fz-juelich.de is the consortium mailing list for any general or specific (e.g., admin-level and account-related) issues.
It is monitored by a subset of members of the [Q02]({{% ref "/references/resources/projects/q02/" %}}) project team based at Forschungszentrum Jülich, led by [Michael Hanke](https://www.trr379.de/contributors/michael-hanke/).

View file

@ -0,0 +1,31 @@
---
title: Tips for the Knowledge Pool
weight: 10
---
To assist with common issues you may encounter while working with the [knowledge pooling tool]({{% ref "/references/services/knowledge-pooling/" %}}), and more specifically with its web UI, we have compiled some [tips](#tips) and [common errors](#common-errors) related to the pool.
## Tips
- It is **highly recommended** to use the knowledge pool's web UI with a desktop browser; the form offers rich contextual information that is hard to access on mobile devices.
- Submitting records will only be possible using a [valid access token]({{% ref "/start/accounts/generate-token/" %}}); the token can be entered by navigating to "Settings" (gear icon) and then pasting your token in the "TOKENS" tab.
- When editing records, you can hover your mouse pointer over field labels to display help text describing expected values and controlled vocabularies.
- For some fields (e.g., journal name when filling out a Publication record), one or more choices have to be selected. The selector offers type-ahead search of choices. When searching:
- Try entering full names instead of abbreviations.
- If an item is not found in one language, try searching its English version.
- Some items might also be searchable by a persistent identifier (e.g., ORCID, DOI, ISSN).
- Wait a few seconds for choices to populate before creating a new record; search results may take time to load.
- Submitting metadata involves two different actions: local saves and submitting to the server. Note that *saving* only stores information in the local browser session; you must *submit* your changes (using the cloud icon in the top-right corner) to make your records visible to consortium workflows.
## Common errors
- **Authorization issues**: If the [access token]({{% ref "/start/accounts/generate-token/" %}}) you are providing is incorrect or does not have appropriate permissions, the interface may display one or more of the following errors during metadata retrieval or submission:
![Screenshot of the "Token not set" error message](token-not-set.webp)
![Screenshot of the token prompt displaying a message about token requirements](token-management.webp)
![Screenshot of an invalid token error message displayed during a record submission attempt](invalid-token.webp)
- **Incomplete information**: If a metadata record is missing required information, you will not be able to save it. Required fields - highlighted with a red asterisk - and an warning sign will alert you to this.
- **Internal errors**: If there is an unexpected error during metadata submission, the submission interface will report technical information. Please [contact the Q02 project team]({{% ref "/support/" %}}) and copy the entire error message.

View file

@ -0,0 +1 @@
/annex/objects/MD5E-s27382--c151e6206f19d6086a30ca9ac863d787.webp

After

Width:  |  Height:  |  Size: 66 B

View file

@ -0,0 +1 @@
/annex/objects/MD5E-s16630--0b5bb2becb3a4ca9141f679daff51a50.webp

After

Width:  |  Height:  |  Size: 66 B

View file

@ -0,0 +1 @@
/annex/objects/MD5E-s8212--85092e88bd936c330fb30daedba73285.webp

After

Width:  |  Height:  |  Size: 65 B

@ -1 +1 @@
Subproject commit c3e18344f1688f7a880b9050793b29c45b4dc1f2
Subproject commit 1fc1cc8915965976e5dc679e2437283d8bc5b337