Skip to content
analysis module for PyGran: a DEM toolkit for rapid quantitative analysis of granular/powder systems
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
PyGranAnalysis
tests
.gitignore
CHANGELOG.md
README.md
__init__.py
setup.py

README.md

Welcome to the PyGran.analysis webpage!

PyGran.analysis is a submodule in PyGran, an open-source toolkit primarily designed for analyzing DEM simulation data. You can read more about PyGran here.

If your find PyGran useful in your research, please consider citing the following paper:

DOI for Citing PyGran

@article{aam2019pygran,
  title={PyGran: An object-oriented library for DEM simulation and analysis},
  author={Abi-Mansour, Andrew},
  journal={SoftwareX},
  volume={9},
  pages={168--174},
  year={2019},
  publisher={Elsevier},
  doi={10.1016/j.softx.2019.01.016}
}

Quick Installation

PyGran.analysis is typically installed with other PyGran submodules. See here for more info. For a solo PyGran.analysis local installation, simply clone this repository and then use pip (or pip3) to run from the source dir:

pip install . --user

You can alternatively run setup.py to build and/install the package. See setup.py -h for more info.

Basic Usage

Using PyGran.analysis for doing post-analysis is quite straight forward. Computing particle overlaps shown below for instance can be done in few lines of code:

import analysis

# Instantiate a System class from a dump file
Gran = analysis.System(Particles='granular.dump')

# Instantiate a nearest-neighbors class
NNS = analysis.Neighbors(Particles=Gran.Particles)
overlaps = NNS.overlaps

For more examples on using PyGran for analyzing DEM simulation, check out the examples page.

You can’t perform that action at this time.