Getting Started

This page guides you step by step through setting up and using Solidipes.

Follow the steps in order:

Install and set up Solidipes
Initialize a Solidipes project
Launch the web interface

Installation and Setup

Solidipes is currently only tested on Linux. Installation is possible on other platforms, but not all features have been fully tested. For Windows users, we recommend using WSL. The installation instructions below are only for Linux.

System requirements:

Python (minimum 3.10).

Recommended: Installation using uv

Use the Python package and project manager uv. After installing uv, run the following command:

uv tool install solidipes

This installs Solidipes in an isolated environment using uv, which handles dependency management automatically.

Alternative: Installation using a virtual environment and pip

First, create a virtual environment to avoid conflicts with Python packages already present on your system.

Using venv (all Python installations)
With Anaconda

Once you have created and activated your environment, run the following command to install Solidipes in the current Python environment:

pip install solidipes

Initializing a Solidipes project

To initialize a Solidipes project, run the following commands:

mkdir my_project
cd my_project
solidipes init

First, mkdir my_project creates a new folder called my_project, which will contain all your Solidipes project files.

Next, cd my_project moves you into the project directory so that all subsequent commands run inside it.

Finally, solidipes init initializes a Solidipes project in the current folder. This folder will contain the following files:

.solidipes/ folder, which contains metadata about your project and files
README file
DESCRIPTION.md file
study_metadata.yaml file
ignore.yaml (optional file exclusion list used to specify files and directories to be ignored by Solidipes)

You can now edit these files through the web interface.

Launching the web interface

Run the command:

solidipes report web-report

and click on the displayed link to open a web interface in your browser. There, you can edit your project’s metadata, curate your data, and publish your project to Zenodo. See the different tutorials on how.