Code Overview

Solidipes curation process relies on the following classes:

• Report

  Defines a script that is callable from the command solidipes report. It would typically use a Scanner for the curation process. Web based reports rely on widgets <solidipes.report.widgets>.

• Scanner

  Defines a set of methods that scan directories, build a tree of files (or group of files), and allow the application of functions on the elements of the tree. One typical use case it to try to load each element of the tree using one of the DataContainer classes.

• DataContainer

  Also referred as Loader. Defines a container for data that allows loading it on demand and applies checks to validate the data in the curation process. One important subclass is the File class, that is used to load files from disk (specified by their mime-type and extension), and allows caching computed information about the files. The DataContainer also lists a set of compatible Viewer classes.

• Viewer

  Defines a viewer for compatible DataContainer classes. It is used to display data in various backends (e.g. terminal, Jupyter notebook, Streamlit).

Other dataset management features of Solidipes rely on the following classes:

• Downloader

  Defines a script that is callable from the command solidipes download.

• Uploader

  Defines a script that is callable from the command solidipes upload.