an application to estimate the slope of a granular surface flow
Go to file
Guillaume Raffy 5cc55990f3 added an option to allow jumping beads to considered as part of the granular media surface
-> grasslooper v1.1

fixes #1
2023-12-07 17:51:36 +01:00
deploy/dockerapp added a deployment solution based on docker 2023-12-07 11:28:43 +01:00
grassloper added an option to allow jumping beads to considered as part of the granular media surface 2023-12-07 17:51:36 +01:00
samples added a sample to test grassloper 2022-12-01 16:12:36 +01:00
.gitignore added a sample to test grassloper 2022-12-01 16:12:36 +01:00
LICENSE Initial commit 2022-10-20 08:41:30 +02:00
README.md improvced documentation 2022-12-01 16:20:08 +01:00
setup.py added an option to allow jumping beads to considered as part of the granular media surface 2023-12-07 17:51:36 +01:00

README.md

grassloper

GRAnular Surface SLOPER: an application to estimate the slope of a granular surface flow

grassloper uses the output of tractrac.

how to install

grassloper is delivered as a simple pip application, and as such it can be installed from scratch using the following steps:

# create a python virtual environment (we name it grassloper.venv)
bob@stykades:~/work/grassloper$ python3 -m venv grassloper.venv  
# activate the virtual environment to use it
bob@stykades:~/work/grassloper$ source ./grassloper.venv/bin/activate
# grassloper requires improtools https://github.com/g-raffy/improtools, which is not in pip's catalog
# install improtools from its source directory (./improtools.git here, downloaded from https://github.com/g-raffy/improtools)
(grassloper.venv) bob@stykades:~/work/grassloper$ pip install -e ./improtools.git
# install grassloper from its source directory (./grassloper.git here)
# this automatically installs the packages that grassloper depends on
(grassloper.venv) bob@stykades:~/work/grassloper$ pip install -e ./grassloper.git
# now that grassloper is installed in grassloper.venv and grassloper.venv is activated, simply run it using its command line 'grassloper'
(grassloper.venv) bob@stykades:~/work/grassloper$ grassloper --help

how to use

grassloper's usage is described with the --help command line argument:

(grassloper.venv) bob@stykades:~/work/grassloper$ grassloper --help

grassloper uses the open source hdf5 file format to store its data. These files can be explored by hdfview or HDFCompass