The HIP. An open-source platform designed for large scale and optimized collection, storage, curation, sharing and analysis of multiscale Human iEEG data at the international level.
HIP onboarding
This quick start guide serves as an introduction to the HIP and briefly explains how to apply for a HIP account, access the platform and operate its main features and services. For more in depth information please refer to the full documentation.
Get a HIP account
An EBRAINS account is required to access the HIP and use all of its services. Apply for an EBRAINS account using the following registration form.
Once your EBRAINS account has been activated, you can apply for a HIP account sending an e-mail to HIP support team with the following information (items marked with an asterisk are mandatory):
Full name*: First name and surname.
HIP group(s)*: At least one HIP group you are affiliated with.
EBRAINS username*: The username you use when logging into EBRAINS services.
Institutional e-mail*: The e-mail that will be used by the HIP support team to contact you.
Backup e-mail*: A backup e-mail.
ORCID: Open Researcher and Contributor ID.
Affiliations and HIP groups
All HIP users are also member of at least one group corresponding to pre-identified institutions listed in the table of HIP groups. Affiliations are cross-checked during the registration process.
Once your application has been validated, a confirmation e-mail will be sent to your institutional e-mail and you will be added to the HIP group on EBRAINS so you can log in the HIP using your EBRAINS credentials. For more information regarding HIP accounts, please refer to the How to create a HIP account guide.
HIP services overview
Home page. The HIP home page provides a set of services (1: Files, 2: Talk, 3: Forms, 4: HIP) which come with their own interface (menu and view) that can be searched (5). The HIP account can be managed using the profile (8), contacts (7) and notifications (6) buttons.
Log in the HIP portal using your EBRAINS account. Once connected to the HIP you will be automatically redirected to your home page from which you can access the platform main features using the side navigation menu. From this menu, it is possible to access the Dashboard which displays various information regarding your institution and its members to whom you can send messages using the Talk service. The Dashboard also shows an overview of the opened Desktops and available BIDS databases in your Private Space. Please note that only the Private Space is available at the moment. For more details regarding the various HIP Spaces, please refer to the How to use the HIP spaces and share data with other users guide.
From the side navigation menu, it is also possible to access the App Catalog, which lists all the applications made available to the HIP users so they can process their data. Applications from the App Catalog are used from virtual Desktops, which operate as remote computers.
The following video (2’15’’), from the How to connect to the HIP portal and access its services guide, shows the connection procedure and gives an overview of all HIP services.
Upload and download data
Data Transfer Agreement (DTA)
A Data Transfer Agreement has to be signed between the participating institution and the CHUV prior to any data transfer taking place.
The HIP user uploading data to the HIP qualify as Data Controller for the corresponding data. It is the Data Controller responsibility to secure proper data pseudonymised/anonymised prior to the transfer, depending on the DTA. Data can only be uploaded in the Private Space of the HIP user doing the transfer. HIP users also have read and write access to the shared folder of each HIP group they belong to. The shared folder is named according to the corresponding HIP group.
There are currently 2 solutions for uploading data to the HIP as explained in the How to prepare and upload data to the HIP guide. It is advised to set up a synchronized folder using the Nextcloud client as illustrated in the following video (2’27’’):
Data type
The HIP is an open-source European platform dedicated to Human intracerebral EEG data and only iEEG data and relevant health-related or research-related data should be uploaded to the platform.
Use desktops and run applications
Desktops operate as remote virtual computers where HIP users can run applications from the App Catalog to process data located in their Private Space. Once it has been initiated, a Desktop will persist until it is manually terminated. HIP users can safely log off and/or close their web browser. Pending Desktops will remain unaltered and accessible for later use.
The procedure to open a Desktop and start applications from the App Catalog is illustrated in the following video (2’30’’), from the How to use Desktops and run applications from the App Catalog guide:
Important
Applications running in a Desktop environment have access to your Private Space data under the /home/<HIP_USER>/nextcloud directory. Any data and/or configuration file outside of this directory will be lost when the application or desktop are closed. This is the only persistent directory as it is tied to the HIP user’s Private Space at application startup. Make sure you are always working within the /home/<HIP_USER>/nextcloud directory when using applications.
Tutorials
There are several tutorials available that can be used to get familiar with the platform:
3D Slicer, for example, can be used to place (non-rigid) SEEG electrodes on a post-implantation volume, as shown in this video tutorial (19’30’’):
Feedback
The HIP is under active development and we need your feedback to improve our products and fix bugs on the platform. Feel free to fill out the dedicated feedback forms available on the platform, your input is greatly appreciated.