graffy
/
grassloper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improvced documentation

This commit is contained in:
Guillaume Raffy 2022-12-01 16:20:08 +01:00
parent e6d3ce683b
commit 6a9f08970b
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -1,13 +1,14 @@
# grassloper # grassloper
an application to estimate the slope of a granular surface flow GRAnular Surface SLOPER: an application to estimate the slope of a granular surface flow
`grassloper` uses the output of [tractrac](https://perso.univ-rennes1.fr/joris.heyman/trac.html).
# how to install # how to install
`grassloper` is delivered as a simple pip application, and as such it can be installed from scratch using the following steps: `grassloper` is delivered as a simple pip application, and as such it can be installed from scratch using the following steps:
```sh ```sh
# create a python virtual environment (we name it name grassloper.venv) # create a python virtual environment (we name it grassloper.venv)
bob@stykades:~/work/grassloper$ python3 -m venv grassloper.venv bob@stykades:~/work/grassloper$ python3 -m venv grassloper.venv
# activate the virtual environment to use it # activate the virtual environment to use it
bob@stykades:~/work/grassloper$ source ./grassloper.venv/bin/activate bob@stykades:~/work/grassloper$ source ./grassloper.venv/bin/activate

3
grassloper/main.py
View File

@ -1,4 +1,3 @@
#!/usr/bin/env python3
import numpy as np import numpy as np
import cv2 import cv2
from pathlib import Path from pathlib import Path
@ -200,7 +199,7 @@ def main():
parser.add_argument('--part-pos-file', type=Path, default=None, required=True, help='the input file containing the particle positions') parser.add_argument('--part-pos-file', type=Path, default=None, required=True, help='the input file containing the particle positions')
parser.add_argument('--results-file', type=Path, default=None, required=True, help='the output file containing for each frame one line fitting the granular surface (hdf5 file format)') parser.add_argument('--results-file', type=Path, default=None, required=True, help='the output file containing for each frame one line fitting the granular surface (hdf5 file format)')
parser.add_argument('--part-pos-file-format', type=str, choices=['tractrac-hdf5'], default='tractrac-hdf5', help='the file format of the input file that contains particle positions') parser.add_argument('--part-pos-file-format', type=str, choices=['tractrac-hdf5'], default='tractrac-hdf5', help='the file format of the input file that contains particle positions')
parser.add_argument('--particle-radius', type=float, required=True, help='the radius of the particles in pixels', default=11) parser.add_argument('--particle-radius', type=float, required=True, help='the radius of the particles in pixels (make sure that the radius is big enough to unsure that neighbouring particles touch each other)', default=11)
parser.add_argument('--debug-dir', type=Path, default=None, help='where to store image processing debug files') parser.add_argument('--debug-dir', type=Path, default=None, help='where to store image processing debug files')
args = parser.parse_args() args = parser.parse_args()
# python3 ./tractrac.git/Python/tractrac.py -f ./grassloper.git/samples/sample002.avi --output 1 -a --saveplot # python3 ./tractrac.git/Python/tractrac.py -f ./grassloper.git/samples/sample002.avi --output 1 -a --saveplot