Metadata-Version: 2.4
Name: solidipes
Version: 1.4.1
Summary: Python package that aids the processes of curating, publishing, and sharing research data
Author-email: Son Pham-Ba <son.phamba@epfl.ch>, Guillaume Anciaux <guillaume.anciaux@epfl.ch>
License: GPL-3.0-or-later
Project-URL: homepage, https://gitlab.com/groups/solidipes
Project-URL: repository, https://gitlab.com/solidipes/solidipes
Project-URL: documentation, https://solidipes.readthedocs.io/en/latest/
Requires-Python: <3.13,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: solidipes-core-plugin>=0.0.37
Requires-Dist: filetype~=1.2.0
Requires-Dist: pandas>=1.5.3
Requires-Dist: streamlit~=1.45.0
Requires-Dist: datasize~=1.0.0
Requires-Dist: pyyaml~=6.0
Requires-Dist: argcomplete~=3.0.5
Requires-Dist: markdown~=3.4.3
Requires-Dist: markdownify~=0.11.6
Requires-Dist: zodb~=6.1.0
Requires-Dist: btrees~=5.2
Requires-Dist: lazy-loader~=0.4
Requires-Dist: rich~=13.9.4
Requires-Dist: rocrate~=0.13.0
Requires-Dist: iso639-lang>=2.6.0
Requires-Dist: ipython>=8.18.1
Requires-Dist: dtoolcore>=3.19.0
Requires-Dist: dtool-s3>=0.14.1
Requires-Dist: tqdm>=4.67.1
Requires-Dist: pip>=25.0.1
Requires-Dist: linkml>=1.8.7
Provides-Extra: dev
Requires-Dist: pre-commit~=4.1.0; extra == "dev"
Requires-Dist: pytest~=8.3.4; extra == "dev"
Requires-Dist: pytest-cov~=5.0.0; extra == "dev"
Requires-Dist: sphinx~=7.2.6; extra == "dev"
Requires-Dist: sphinx-rtd-theme~=2.0.0; extra == "dev"
Requires-Dist: myst-parser~=2.0.0; extra == "dev"
Requires-Dist: pillow~=10.4.0; extra == "dev"
Requires-Dist: pixelmatch~=0.3.0; extra == "dev"
Requires-Dist: git-changelog~=1.0.0; extra == "dev"
Requires-Dist: seleniumbase==4.33.12; extra == "dev"
Requires-Dist: git-changelog; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: jupyterlab; extra == "dev"
Requires-Dist: jupyterlab-widgets; extra == "dev"
Requires-Dist: itkwidgets; extra == "dev"
Requires-Dist: urllib3; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest~=8.3.4; extra == "test"
Requires-Dist: pytest-cov~=5.0.0; extra == "test"
Requires-Dist: pillow~=10.4.0; extra == "test"
Requires-Dist: pixelmatch~=0.3.0; extra == "test"
Requires-Dist: seleniumbase==4.33.12; extra == "test"
Provides-Extra: doc
Requires-Dist: urllib3; extra == "doc"
Requires-Dist: sphinx~=7.2.6; extra == "doc"
Requires-Dist: sphinx-rtd-theme~=2.0.0; extra == "doc"
Requires-Dist: myst-parser~=2.0.0; extra == "doc"
Dynamic: license-file

# Solidipes

_Python package that aids the processes of curating, publishing, and sharing research data_

[![PyPI version](https://badge.fury.io/py/solidipes.svg)](https://badge.fury.io/py/solidipes)
[![Read the Docs](https://readthedocs.org/projects/solidipes/badge/?version=latest)](http://solidipes.readthedocs.io/)

See the package's documentation on [Read the Docs](http://solidipes.readthedocs.io/).

<div style="text-align: center;">
    <img src="https://gitlab.com/solidipes/solidipes/-/raw/main/logos/solidipes.png" width="180px" height="180px">
</div>


# Installation

## As regular user

```bash
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](https://docs.astral.sh/uv/) to manage dependencies


### Installation

```bash
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](https://graphviz.org/download/)


### Build

Run the following command to build the documentation locally:

```bash
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
```bash
solidipes --help
```

Consult the documentation in the [Getting started](https://solidipes.readthedocs.io/en/latest/src/getting_started.html#usage-from-the-command-line) section for next steps.
