tutorials

tutorials - getting started with dtool

This page lists didactic material available for components of the dtool ecosystem.

command line client

The dtool-demo repository contains several sample terminal sessions that demonstrate working with the dtool CLI. The following videos have been generated from these terminal sessions. For thorough documentation, refer to dtool.readthedocs.io.

setup

copy dataset from remote

dataset creation

copy dataset to remote

search and query dserver

graphical user interface

Following videos show how to work with the dtool-lookup-gui, an experimental graphical user interface for the dtool & dserver research data management ecosystem. For thorough documentation, refer to dtool-lookup-gui.readthedocs.io.

setup

copy dataset from remote

dataset creation

copy dataset to remote and find with dserver

search professionally with MongoDB query language, navigate dependency graph

dserver demonstrator instance

demo.dtool.dev exposes an open dserver instance as a playground for first steps with the dtool ecosystem.

To populate a local dserver instance with some sample datasets, download the dtool sample family sample-datasets.zip, extract them and run

docker run -v $(pwd)/sample-datasets:/tmp/data:ro -p 8888:8888 ghcr.io/livmats/dserver-minimal:latest

from within the folder of extraction. This mounts the freshly extracted local folder sample-datasets into the docker container as a dataset repository. http://localhost:8888 now exposes the dserver web app and lists a family of datasets. http://localhost:8888/lookup/doc/swagger exposes dserver’s interactive REST API documentation.

dtool & dserver cheat sheet