Starting the web interface

If you don’t have any data yet, it is important to think about how you want to structure your data. This can later help for visualization, analysis and publication. To make it easier for you, we have created a few templates that you can use to create your own project.

If you already have your data organized use the following steps to start a solidipes project.

Tip

Place all of your data into a data directory in your project directory.

Create a new project directory and enter it


mkdir my_project
cd my_project

Initialize Solidipes

solidipes init

This will create:

  • .solidipes folder in your project directory. This directory contains all the information about your project.

  • DESCRIPTION.md file with the description of the project/dataset (To be filled by you).

  • README.md file, automatically generated, containing standard metadata concatenated with the description.

Note

The README.md file is generated by Solidipes and should not be modified directly. Instead, descriptive information beyond the standard metadata should be put in DESCRIPTION.md, while metadata can be filled with the web interface.

Launch the web interface


You can check the sanity of your data, visualize and describe your project as well as modify the meta data in a web interface using the solidipes report web-report command.

This Graphical User Interface allows to:

  • modify accordingly the study_metadata.yaml and DESCRIPTION.md files

  • validate the sanity of the files in the dataset

  • scrutinize the files for a visual control

Run:

solidipes report web-report

Sharing

You project can be shared with other people online using a similar interface. Check the Sharing with Renku section for guidance.