📝 docs(README.md): update README with new features and installation instructions
The README file has been updated to include a more detailed description of the Analyse Morphologique tool, including its features and capabilities. Additionally, installation and usage instructions have been added to the README file to help users get started with the tool.
This commit is contained in:
parent
6803443385
commit
d1811b99b9
60
README.md
60
README.md
@ -1,2 +1,60 @@
|
|||||||
# AnalyseMorphologique
|
# Analyse Morphologique
|
||||||
|
|
||||||
|
Analyse morphologique est un outil developpé par le laboratoire geomecanique du centre PACA d'INRAE. Son but est d'extraire des informations sur la morphologie de scan 3D issues de tests HET (Hydraulic Erosion Test).
|
||||||
|
## Fonctionnalités
|
||||||
|
|
||||||
|
### Analyse de l'objet
|
||||||
|
- Lecture de fichiers .obj et .xyz
|
||||||
|
- Redressement et normalisation de l'objet
|
||||||
|
- Discretisation de l'objet en couche de taille egale
|
||||||
|
- Calcul d'indices morphologiques
|
||||||
|
- Export des indices morphologiques dans un fichier
|
||||||
|
- Affichage de graphiques :
|
||||||
|
- Maillage de l'objet
|
||||||
|
- Coupe de l'objet sur les axes xz et yz
|
||||||
|
- Evolution du rayon moyen en fonction de la hauteur
|
||||||
|
- Evolution de la difference entre le rayon moyen de chaque couche et la moyenne des rayons moyen en fonction de la hauteur
|
||||||
|
- Coupe d'une couche selectionnée
|
||||||
|
- Evolution de la difference entre le rayon de chaque point et le rayon moyen de la couche en fonction de l'angle theta (de 0 a 2pi)
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Installation et utilisation
|
||||||
|
|
||||||
|
Attention, ce programe ne fonctionne qu'avec les version de python 3.10 et superieur.
|
||||||
|
|
||||||
|
Pour utiliser programme, il suffit de cloner le depot, ou de télécharger une des [releases disponibles](https://forgemia.inra.fr/scanner3d/analysemorphologique/-/releases) et d'installer les dépendances avec pip.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://forgemia.inra.fr/scanner3d/analysemorphologique.git
|
||||||
|
cd analysemorphologique
|
||||||
|
pip install -r requirements.txt
|
||||||
|
python main.py
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environement virtuel
|
||||||
|
|
||||||
|
Si vous utilisez Anaconda, il est possible que vous aiyez des problemes avec la bibliotheque pyQt.
|
||||||
|
|
||||||
|
```
|
||||||
|
```
|
||||||
|
|
||||||
|
vous pouvez neamoins utiliser le programe en créant un environement virtuel avec les dépendances necessaires. Pour cela, il faut créer un environement virtuel, l'activer, puis installer les dépendances.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install venv
|
||||||
|
python -m venv venv
|
||||||
|
# Pour les utilisateurs de windows
|
||||||
|
venv\Scripts\activate.bat
|
||||||
|
# Pour les utilisateurs de linux ou mac
|
||||||
|
source venv/bin/activate
|
||||||
|
pip install -r requirements.txt
|
||||||
|
python main.py
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user