Solidipes

Python package that aids the processes of curating, publishing, and sharing research data

See the package's documentation on Read the Docs.

Directory structure

• docker/: contains a Dockerfile to build and run Solidipes on cloud platforms like DCSM or Renku
• docs/: Source for Solidipes' documentation (Sphinx)
• examples/: Example Python scripts and notebooks for programmatic usage
• plugins/: Git submodules for Solidipes plugins developed by the core team
  • astro/: Astrophysics plugin developed by LASTRO, EPFL
  • core/: Plugin with essential features for Solidipes
  • solid-mech/: Solid mechanics plugin developed by LSMS, EPFL
• solidipes/: Main source code of the Solidipes package
• tests/: Unit tests suite

Installation

As regular user

pip install solidipes

As developer

If you intend to implement new features into the code (like implementing a new reader for a specific file format or a new type of report), you need to get the source code of Solidipes.

Dependencies

• Python (3.10 minimum)
• make
• uv to manage dependencies

Installation

git clone https://gitlab.com/solidipes/solidipes.git
cd solidipes
make install

This will install Solidipes as well as all the Python development dependencies. It will also fetch Solidipes plugins in the plugins directory.

Build the documentation

Dependencies

• Graphviz

Build

Run the following command to build the documentation locally:

cd docs
make html

The documentation will be available in the docs/build/html directory.

Usage from the command line

To see a list of all available commands, run

solidipes --help

Consult the documentation in the Getting started section for next steps.

License

The Solidipes package is licensed under the GNU General Public License v3.0. Its documentation is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0).

Acknowledgements

The DCSM project was funded by two Open Research Data (ORD) Explore grants and an Open Educational Resources (OER) grant delivered by the ETH Board.