Skip to main content

Solidipes

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

PyPI version Read the Docs

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

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.

Metadata

Release files for solidipes 1.4.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for solidipes 1.4.11
File Size Uploaded
solidipes-1.4.11.tar.gz 38.8 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for solidipes 1.4.11
File Interpreter ABI Platform
solidipes-1.4.11-py3-none-any.whl Python 3 none any Details

Total release size: 38.9 MB

Release files / solidipes-1.4.11.tar.gz

Download URL solidipes-1.4.11.tar.gz
Size 38.8 MB
Tags Source
SHA-256 checksum
How to use checksums
1b27d774336843face79d5d60f61f7d981a13197cb10224208671c41698f8e12
BLAKE2b-256 checksum
How to use checksums
ee85bfc202eb1425b85b0758f05b45ef214fca0ef7b48208fb8882443d2324df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8

Release files / solidipes-1.4.11-py3-none-any.whl

Download URL solidipes-1.4.11-py3-none-any.whl
Size 110.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cc9a3b6fbea1219de75e4af4af2eb299a684e21181f0deb6912f93821622e62d
BLAKE2b-256 checksum
How to use checksums
1e56aca92b306ddf557b7a0732954858adc2f4c88fdf72808db14effd9348163
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page