Michał Szczepanik
418640d0c6This is a rewrite of the documentation, which shifts the "dataladification" process from admin docs to user docs. This reflects a change in process compared to initial plans: while DataLad datasets can be created by ICF and placed alongside tarballs, this step will most likely be done by users on their institute local infrastructure. While most of the previous information is retained, the docs are restructured, with the user part becoming more extensive.
37 lines
1.3 KiB
ReStructuredText
37 lines
1.3 KiB
ReStructuredText
Browser-based access
|
|
--------------------
|
|
|
|
Study directory listing can be viewed in a web browser, by navigating
|
|
to an address composed of: ``<store base URL>/<study identifier>``.
|
|
Users will be prompted for credentials. The listing will contain the
|
|
following:
|
|
|
|
* DICOM files in tar archives, one per visit, ``<visit ID>_dicom.tar``
|
|
* Checksums of the tar archives, allowing verification of data
|
|
integrity, ``<visit ID>_dicom.tar.md5sum``
|
|
* (optional) a ``catalog`` directory containing a catalog of the study
|
|
visits (which can be used to view e.g. available modalities and
|
|
DICOM series for each visit)
|
|
|
|
|
|
.. code-block:: console
|
|
|
|
data.inm-icf.de/my-study
|
|
├── P000123_dicom.tar
|
|
├── P000123_dicom.tar.md5sum
|
|
└── datalad_catalog/
|
|
|
|
Catalog-based browsing
|
|
======================
|
|
|
|
If a catalog has been generated for a given study, users will be able to
|
|
browse through the directory tree with additional annotations
|
|
of available metadata, and search for acquisitions based on keywords
|
|
or name, by entering the ``datalad_catalog`` directory.
|
|
|
|
Downloads
|
|
=========
|
|
|
|
tar archives and checksums can be downloaded individually by clicking
|
|
on them in the plain directory listing of the store.
|
|
Alternatively, they can be downloaded in the catalog browser in the ``Content`` menu of each individual acquisition.
|