Skip to content
Snippets Groups Projects
Commit af88bb22 authored by Florian Spreckelsen's avatar Florian Spreckelsen
Browse files

FIX: Typos

parent 41962a41
No related branches found
No related tags found
2 merge requests!160STY: styling,!143ENH: HDF5 Converter
Pipeline #47455 passed
...@@ -235,7 +235,7 @@ HDF5 Converters ...@@ -235,7 +235,7 @@ HDF5 Converters
For treating `HDF5 Files For treating `HDF5 Files
<https://docs.hdfgroup.org/hdf5/develop/_s_p_e_c.html>`_, there are in total <https://docs.hdfgroup.org/hdf5/develop/_s_p_e_c.html>`_, there are in total
four indivdual converters corresponding to the internal structure of HDF5 files: four individual converters corresponding to the internal structure of HDF5 files:
the :ref:`H5FileConverter` which opens the file itself and creates further the :ref:`H5FileConverter` which opens the file itself and creates further
structure elements from HDF5 groups, datasets, and included multi-dimensional structure elements from HDF5 groups, datasets, and included multi-dimensional
arrays that are in turn treated by the :ref:`H5GroupConverter`, the arrays that are in turn treated by the :ref:`H5GroupConverter`, the
...@@ -260,7 +260,8 @@ metadata and their internal path within the HDF5 file. Users can thus query for ...@@ -260,7 +260,8 @@ metadata and their internal path within the HDF5 file. Users can thus query for
datasets and their arrays according to their metadata within LinkAhead and then datasets and their arrays according to their metadata within LinkAhead and then
use the internal path information to access the dataset within the file use the internal path information to access the dataset within the file
directly. The type of this record and the property for storing the internal path directly. The type of this record and the property for storing the internal path
need to be reflected in the datamodel. Using the default names, you would need a datamodel like need to be reflected in the datamodel. Using the default names, you would need a
datamodel like
.. code-block:: yaml .. code-block:: yaml
...@@ -272,7 +273,7 @@ need to be reflected in the datamodel. Using the default names, you would need ...@@ -272,7 +273,7 @@ need to be reflected in the datamodel. Using the default names, you would need
although the names of both property and record type can be configured within the although the names of both property and record type can be configured within the
cfood definition. cfood definition.
A simple example of a cfood definiton for HDF5 files can be found in the `unit A simple example of a cfood definition for HDF5 files can be found in the `unit
tests tests
<https://gitlab.com/linkahead/linkahead-crawler/-/blob/main/unittests/h5_cfood.yml?ref_type=heads>`_ <https://gitlab.com/linkahead/linkahead-crawler/-/blob/main/unittests/h5_cfood.yml?ref_type=heads>`_
and shows how the individual converters are used in order to crawl a `simple and shows how the individual converters are used in order to crawl a `simple
...@@ -286,7 +287,7 @@ H5FileConverter ...@@ -286,7 +287,7 @@ H5FileConverter
This is an extension of the This is an extension of the
:py:class:`~caoscrawler.converters.SimpleFileConverter` class. It opens the HDF5 :py:class:`~caoscrawler.converters.SimpleFileConverter` class. It opens the HDF5
file and creates children for any contained group or dataset. Additionaly, the file and creates children for any contained group or dataset. Additionally, the
root-level attributes of the HDF5 file are accessible as children. root-level attributes of the HDF5 file are accessible as children.
H5GroupConverter H5GroupConverter
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment