Home
EDEMpy
EDEMpy is a Python library for accessing EDEM data from .h5 files (the underlying EDEM file format). EDEMpy does not require prior knowledge of advanced programming.
EDEMpy Syntax
The following sections provide an overview of the syntax used in EDEMpy.
Create Bins
EDEMpy offers methods for binning objects using the BoxBin and CylinderBin classes.

Welcome
What's New
New features and enhancements available in EDEM.
Release Notes
This document contains information about the EDEM release, such as key features and enhancements, bug fixes, and known issues.
About EDEM
EDEM is a high-performance simulation software for bulk and granular materials.
Get Started with EDEM
The EDEM user interface comprises three icons for each simulation component - Creator, Simulator, and Analyst.
EDEM Creator
EDEM Creator is the pre-processor for creating an EDEM simulation model, including setting up equipment and defining the generation of bulk materials.
EDEM Simulator
EDEM Simulator is a powerful solver used for fast and efficient simulations.
EDEM Analyst
EDEM Analyst is the post-processor used to analyze and visualize the results of your simulation.
EDEM Contact Models
A Contact Model describes how elements behave when they come into contact with each other.
EDEM Cal Utility
EDEM Cal is a utility which works with EDEM and is designed to assist in performing calibration.
GPU CUDA Guide
The EDEM CUDA GPU module uses the latest General Purpose Computing on Graphical Processing Units (GPU) technology.
Programming Guide
The EDEM Programming Guide describes the EDEM API.
Coupling Interface Programming Guide
The Coupling Interface Programming Guide provides an overview of how to use the EDEM Coupling Interface to couple with a generic CFD code and/or Multi Body dynamics codes.
EDEMpy
EDEMpy is a Python library for accessing EDEM data from .h5 files (the underlying EDEM file format). EDEMpy does not require prior knowledge of advanced programming.
- Set up a Python Virtual Environment
  A Python Virtual Environment is a folder containing a standalone Python installation. It is recommended to create a new Virtual Environment for each Python project, as this helps track project dependencies and enables sharing of Python projects.
- Install EDEMpy
  The EDEM installation folder includes EDEMpy as a PIP package file ready to be installed.
- EDEMpy Syntax
  The following sections provide an overview of the syntax used in EDEMpy.
  - Load a Deck
    To start using EDEMpy, load an existing deck by creating a Deck object and providing the full path to a .dem file. By default, decks are loaded in 'read-only' mode to prevent any accidental changes.
  - Read Particle Data
    You can read particle information (positions, velocities, and so on) for a given particle type in a given Time Step which is contained in a ParticleType object.
  - Read Geometry Data
    You can query Geometry information in a similar way to querying particles.
  - Read Contact, Bond, and Collision data
    You use the same syntax for reading contact and collision data. The only differences are in the available properties in each case.
  - Create Bins
    EDEMpy offers methods for binning objects using the BoxBin and CylinderBin classes.
  - Write Data
    EDEMpy provides functionality to modify decks for the purposes of automated pre-processing.
  - Custom Properties
    EDEMpy has four types of custom properties that you can read from and write into.
EDEM Solver Capabilities
EDEM contains four solver engines.
Appendix
This section provides additional information about how to estimate simulation time, supported EDEM File types, attribute definitions, and so on.
EDEM Terminology
Definitions of terms used in EDEM.
References and Bibliography
This section cites the contributions made by various authors and sources that have been used as reference material for EDEM, and the specifics of how they have been applied can be found in the individual contact model sections.

Create Bins

EDEMpy offers methods for binning objects using the BoxBin and CylinderBin classes.

To create bins:

To import classes, use the following:
```
from edempy import BoxBin, CylinderBin
```
BoxBin is defined by an origin [x, y, z] and edge lengths.

CylinderBin is defined by the Start and End points [x, y, z] , and a radius.
To search for any arbitrary list of objects inside a bin, pass two arguments to the getBinnedObjects() function.
Example
```
boxbin = BoxBin([-0.25, 0.0, 0.0], 0.3, 1.0, 0.2)
ids = deck.timestep[tStep].particle[0].getIds()
pos = deck.timestep[tStep].particle[0].getPositions()
binned_ids = boxbin.getBinnedObjects(ids, pos)
```
The getBinnedObjects() function also accepts arguments for queryType (‘max’, ‘min’, ‘average’, or ‘total’) and transform where you can specify a 4x4 transformation matrix for translating and rotating the bin. Use this with the getTransformMatrix() function on Geometries to allow the bins to track Geometry motion.
To read binned properties, use the getBinnedProperty() function to collect binned particle, contact, and bond data.
```
binnedAveVel, x, y, z =
                  deck.timestep[tstep].particle[0].getBinnedProperty(50, 50, 50,
                                                                        option='velocity’,
                                                                        average=True)
```
This returns the binned average velocity for particle type 0, and the x, y, and z positions of the bins. It is useful for displaying EDEM data as a continuum, and plotted using Matplotlib functions such as contour() .

You can also use it to calculate custom properties, such as the segregation index.

By default, the bin’s max and min coordinates match the simulation domain, but you can also pass custom limits. The default option returns IDs.