Metadata-Version: 2.1
Name: solidipes
Version: 0.1.2
Summary: Python package for the DCSM project
Home-page: https://gitlab.com/groups/dcsm
Author: Son Pham-Ba
Author-email: son.phamba@epfl.ch
Requires-Python: >=3.8, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: argcomplete (>=3.0.5,<4.0.0)
Requires-Dist: cairosvg (>=2.7.0,<3.0.0)
Requires-Dist: datasize (>=1.0.0,<2.0.0)
Requires-Dist: filetype (>=1.2.0,<2.0.0)
Requires-Dist: ipydatawidgets (==4.3.2)
Requires-Dist: markdown (>=3.4.3,<4.0.0)
Requires-Dist: matplotlib (>=3.7.1)
Requires-Dist: meshio[all] (>=5.3.4,<6.0.0)
Requires-Dist: openpyxl (>=3.1.1,<4.0.0)
Requires-Dist: pandas (>=1.5.3)
Requires-Dist: python-gitlab (>=3.14.0,<4.0.0)
Requires-Dist: pyvista (>=0.38.1,<0.39.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Requires-Dist: requests-toolbelt (>=0.10.1,<0.11.0)
Requires-Dist: scipy (>=1.10.1)
Requires-Dist: stpyvista (>=0.0.6,<0.0.7)
Requires-Dist: streamlit (>=1.17.0,<2.0.0)
Requires-Dist: streamlit-ace (>=0.1.1,<0.2.0)
Requires-Dist: streamlit-js-eval (>=0.1.5,<0.2.0)
Requires-Dist: streamlit-option-menu (>=0.3.2,<0.4.0)
Requires-Dist: streamlit-tree-select (>=0.0.5,<0.0.6)
Requires-Dist: sympy (>=1.11.1)
Requires-Dist: tqdm (>=4.65.0,<5.0.0)
Requires-Dist: trame (>=2.2.6,<3.0.0)
Project-URL: Documentation, https://solidipes.readthedocs.io/en/latest/
Project-URL: Repository, https://gitlab.com/dcsm/solidipes
Description-Content-Type: text/markdown



# Solidipes

_Python package for the DCSM project_

[![](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/).

<img src="https://gitlab.com/dcsm/solidipes/-/raw/dev/logos/solidipes.jpg" width="200px" height="200px">


# 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.8 minimum)
- make
- [Poetry](https://python-poetry.org/docs/#installation)

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

This will install Solidipes as well as all the development dependencies.


# Usage from the command line

To see a list of all available commands, run
```
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.

