BlueQuartzSoftware / DREAM3D

Data Analysis program and framework for materials science data analytics, based on the managing framework SIMPL framework.
http://dream3d.bluequartz.net
Other
158 stars 73 forks source link
analysis c-plus-plus data-analysis data-science filter materials-informatics materials-science microstructure multimodal-data

About DREAM.3D

DREAM3D Logo

DREAM.3D is an open source, cross-platform and modular software package that allows users to reconstruct, instantiate, quantify, mesh, handle and visualize multidimensional, multimodal data. DREAM.3D is built on top of the SIMPL and SIMPLView software projects and contains a filter suite designed for the materials scientist to utilize to reconstruct 3D microstructures or synthetically generate microstructures. The core software package has many major functionalities, including:

Precompiled Binaries for Windows/MacOS/Linux

Please download a precompiled binary for your platform from dream3d.bluequartz.net

Anaconda Python Distribution

There is an anaconda distribution available for DREAM.3D. This gives python developers/users the ability to call every DREAM.3D filter directly from python.

conda config --add channels conda-forge
conda create  -n dream3d python=3.7 numpy imageio
conda activate dream3d
conda install -c http://dream3d.bluequartz.net/binaries/conda dream3d-conda

The API docs are located at http://www.dream3d.io/python_docs/html/

General Features

EBSD Data Processing

Synthetic Microstructure Generation

Data Visualization

The above items represent only a subset of the specific capabilities of DREAM.3D. In general, DREAM.3D can be considered a generic tool for processing multidimensional, multimodal data. The main DREAM.3D web site has more information on the project, in addition to official binary distributions and example data files.

DREAM.3D is built with a Plugin system that allows other institutions to build additional Filters using their own programming resources and intellectual property and still protect those rights under a license of their selection.

Documentation

The documentation for the current release is posted at http://www.dream3d.io. This is the same documentation that is available from within the DREAM.3D application, just posted online.

License

See the Copying.md file for CopyRight & license

Building DREAM.3D

If you would like to create new features/functionality/filters for your own use or to contribute back to the community, please go to the DREAM3DSuperbuild

Current build status for the build farm is located at the CDash site.

Nightly Builds

Nightly snapshot builds are available for download here. These binaries are built every night from the head of the develop branch, and may have bugs or other instabilities.

Getting Help

Please sign up for the DREAM.3D Users Google group. It's the fastest way to ask your DREAM.3D questions, get help with using DREAM.3D, and connect with both developers and the community at large. If you are interested in contributing to the DREAM.3D project, also sign up to the DREAM.3D developers Google group to get help with compiling and adding to DREAM.3D.

If you find an error with DREAM.3D or want to request a new feature, please open up an issue.

Contributing to DREAM.3D

Please reference the Contributing file for more information on contributing to the DREAM.3D project.

Acknowledgments

DREAM.3D has been developed under several United States Department of Defense contracts. The DoD has graciously allowed the bulk of DREAM.3D to be open-sourced. In particular the Air Force Research Laboratory was the principal funding agency through out most of the development. Code contributions from academia including Carnegie Mellon University were also instrumental in creating DREAM.3D. The full list of contributors can be found here