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.

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.
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.

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 enables pre-processing and post-processing of EDEM data using the vast array of tools offered by the Python ecosystem.

EDEMpy is installed by default with EDEM, including its dependencies: NumPy and h5py. It is also recommended to install the following tools, as these are commonly used by EDEM users and are mandatory for some of the examples (available in the EDEM knowledge base):

Matplotlib: Python library for data plotting and visualization

Currently, the officially supported platform for EDEMpy is Python version 3.8.10.

The default Altair installation path includes the correct version installed at:

Windows:C:\Program Files\Altair\<version number>\common\python\python3.8\win64\python.exe
Linux:~/<version number>/altair/common/python/python3.8/linux64/bin/python

CAUTION: It may not be safe to modify the Altair Python installation by installing EDEMpy or any other packages. This could cause unexpected behavior in EDEM and other Altair software. It is recommended to follow these instructions to create an independent Virtual Environment for each project.

Get Started with EDEMpy Documentation

EDEMpy API documentation is included in the EDEM installation folder.

For more information about the installation, see the Help included in the EDEM installation folder.

Alternatively, the default installation path is as follows:

Windows: C:\Program Files\Altair\<version number>\EDEM\EDEMpy\help\index.html
Linux: ~/<version number>/altair/EDEM/EDEMpy/help/index.html

You can access the same information for individual functions directly from a Python console using the built-in help() command. For example, to see the documentation for the Deck class, use the following command:

python
>>> import edempy
>>> help(edempy.Deck)

For more information about EDEMpy examples, see the EDEM Community pages.