Skip to content
Snippets Groups Projects
Verified Commit e06e7938 authored by Björn Ludwig's avatar Björn Ludwig
Browse files

docs(dataset): improve docstring of ZeMASamples

parent 0fda88e4
No related branches found
No related tags found
No related merge requests found
Pipeline #16358 failed
...@@ -53,6 +53,7 @@ html_theme_options = { ...@@ -53,6 +53,7 @@ html_theme_options = {
intersphinx_mapping = { intersphinx_mapping = {
"np": ("https://numpy.org/doc/stable/", None), "np": ("https://numpy.org/doc/stable/", None),
"Python": ("https://docs.python.org/3", None), "Python": ("https://docs.python.org/3", None),
"pooch": ("https://www.fatiando.org/pooch/latest/", None),
} }
# We keep the objects.inv files in our docs folder to get hints on how to specify the # We keep the objects.inv files in our docs folder to get hints on how to specify the
# cross-references. More on the topic can be found here: # cross-references. More on the topic can be found here:
......
...@@ -65,6 +65,13 @@ class ZeMASamples: ...@@ -65,6 +65,13 @@ class ZeMASamples:
The underlying dataset is the annotated "Sensor data set of one electromechanical The underlying dataset is the annotated "Sensor data set of one electromechanical
cylinder at ZeMA testbed (ZeMA DAQ and Smart-Up Unit)" by Dorst et al. [Dorst2021]_. cylinder at ZeMA testbed (ZeMA DAQ and Smart-Up Unit)" by Dorst et al. [Dorst2021]_.
Each extracted sample will be cached in the download directory of the file,
which is handled by :func:`pooch.os_cache`, where ``<AppName>`` evaluates to
``pooch``. That way the concurrent retrieval of the same data is as performant as
possible and can simply be left to ``zema_emc_annotated``. Where ever the result
of ``ZeMASamples`` is needed in an external code base, it should be safe to call
it over and over without causing unnecessary extractions or even downloads. The
underlying mechanism is Python's built-in ``pickle``.
Parameters Parameters
---------- ----------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment