Repo4Cat - The Place for Sharing Catalysis Data.
Welcome to the documentation for the NFDI4Cat Central Data Repository,
https://repository.nfdi4cat.org
a platform dedicated to facilitating the storage, organization, and sharing of research data from catalysis science.
Do you have some nice ideas or like to give feedback on how to make things better or easier? Don't hesitate and create an issue to let us know!
Below you can find the most important information about this repository.
We are currently working on a better documentation for Repo4Cat built with Sphinx and myST. The sources are in the docs folder of this repo. The resulting documentation site is available at https://nfdi4cat.github.io/repo4cat/.
Help on the documentation is very welcome!
- Repository is based on Dataverse software
- Official Dataverse documentation, especially:
- User Guide
- Collection management (dataverse/dataset level)
- Roles and permissions (dataverse level)
- File management (dataset level)
- First steps in NFDI4Cat Central Data Repository, guideline - https://hdl.handle.net/21.11165/4Cat/b4au-u4m3
Do you need a playground for any tests and experiments? Please also try our demo repository - a full functionality and already prepared training materials will help you to make the first steps!
Create a personal account:
- Use "Sign up for a Dataverse account" button on the login page.
- Please use your real "Given Name" and "Family Name".
- Please set "Username" as combination of "GivenName.FamilyName" all with small letters without quotes, e.g. max.mustermann. This approach will allow us to find each other and share information with each other on an easy way in Dataverse.
- Set a real Email address to allow Dataverse to send you notifications. Sometimes it is practical to make some filters in your mailing system to sort emails from Dataverse in a separate folder, because every creation of information will be followed by a mail.
- Please set a strong password, e.g. using some password generator or just "openssl rand -base64 18" command in Linux (you can replace "18" with other number to get different length and symbols).
Permissions and access rights:
In Dataverse (the repository software) permissions are controlled at the "dataverse collections" level. Note, a "dataverse collection" (often just called a "dataverse") is a folder-like structure that can store one or more datasets (which in turn contain the files to share). A dataverse can also contain other dataverses (for more, see useful links above).
- Based on the Dataverse access control system users can have different access rights (permissions) in different dataverses. Every user can create a personal "dataverse" and then decide, what other users are allowed to do with their dataverse via the "Edit -> Permissions" button.
- Access to some areas in the repository must be explicitly granted by administrators, see information below.
The NFDI4Cat Central Data Repository comes with a pre-defined internal structure. It includes a few top-level dataverses which can be further extended by the users with (sub-)dataverses.
The structure is the following:
- Scope of work: area for collaboration in projects that involve multiple institutions.
- Creation of the project: access to this dataverse must be requested from administrators (write a short message with the project name via "Contact" button there: https://repository.nfdi4cat.org/dataverse/projects . Administartors will create a new dataverse "Your Project Name" with the identifier (URL) ".../your-project-name" and will set one person as a local administrator there (via special group, see "User groups" below ). This person will manage after that the access rights for this specific dataverse - who can access, what will be allowed to do, etc. (via "Edit -> Permissions" buttons).
- User groups: every project must have specific user groups, which are administrated by local administrators of this dataverse (==project). Naming for the user groups - must be created from the prefix "ug-", group name and related role in the plural form, like "ug-your-project-name-admins" (for admins) and "ug-your-project-name-curators" (for curators) or "ug-your-project-name-dv-creators" (for dataverse creators) with related permissions. The first group "...-admins" will be created by the repository main administrators (Support team) and one person will be added to this group - the person, who has asked about the new project. More detailed information about avaialble roles and permissions you can find above under useful links. Configuration of the user groups can be done via the "Edit -> Groups" menu.
- New users: will be managed by the local administrators of the project (user group "ug-your-project-name-admins") via specific user groups like e.g. "ug-your-project-name-dv-creators" for dataverse creators or user groups with other roles (see "User groups" above).
- Access rights: will be managed by the local administrators of the project (user group "ug-your-project-name-admins") via specific user groups (see "User groups" above). Is proposed to allow users to only create new dataverses inside of the project dataverse (role "dataverse creator") and position "When a user adds a new dataset to this dataverse, which role should be automatically assigned to them on that dataset?" can be set to "contributor". Users then have to crate a perosonal dataverse, where inside they will be local admins automatically, so they can e.g. create new own dataverses and datasets inside, which can be published as well. Configuration of the access rights can be done via the "Edit -> Permissions" menu.
Example: ...
- Scope of work: area for internal collaboration within one organizations, e.g. some institution.
- Creation of the organization: see projects above. Access to this dataverse must be requested from administrators. Naming of identifier (URL) ".../your-organization-name".
- User groups: see projects above. Naming for the organizational user groups - must be created from the prefix "ug-", organization name and related role in the plural form, like "ug-your-organization-name-admins" (for admins) and "ug-your-organization-name-curators" (for curators) or "ug-your-organization-name-dv-creators" (for dataverse creators) with related permissions.
- New users: see projects above using specific user group namimg style for organizations.
- Access rights: see projects above using specific user group namimg style for organizations.
Example: ...
- Scope of work: area to store user's personal dataverses to work alone or in cooperation with colleagues.
- Creation of the dataverse: every user can create own dataverse. Please create your personal dataverse with an identifier as "name-surname" (with a minus "-" sign, it will be used in URL). Name of your dataverse can be flexible, e.g. "Name Surname".
- User groups: user who has created a personal dataverse is automatically an administrator of this dataverse and that's why can create custom user groups inside of this dataverse or just invite other users without group creation. Naming of user groups is free, but is better to use some naming system like e.g. in projects above.
- New users: every user account has access to this area, no specific creations are needed.
- Access rights: same access rights for every user with the role "Dataverse Creator". Position "When a user adds a new dataset to this dataverse, which role should be automatically assigned to them on that dataset?" is set to "contributor".
Example: ...
- Scope of work: area for single publications (datasets), available for every researcher independent from the project or organization. Important: only datasets can be created here!
- Creation of the publication: every user can create own "dataset" as a separate publication.
- User groups: no user groups needed. Roles are same for every user - possibility to create own "dataset" (publication).
- New users: every user account has access to this area, no specific creations are needed.
- Access rights: same access rights for every user with the role "Dataset Creator". Position "When a user adds a new dataset to this dataverse, which role should be automatically assigned to them on that dataset?" is set to "curator", so users can publish their datasets directly without any approvement of the administrators.
Example: ...
The content of this repository and its gh-pages is CC-BY-4.0 licensed, see LICENSE for details.
This work was funded by the German Research Foundation (DFG) through the project "NFDI4Cat - NFDI for Catalysis-Related Sciences" (DFG project no. 441926934), within the National Research Data Infrastructure (NFDI) programme of the Joint Science Conference (GWK).