Skip to content

Latest commit

 

History

History
159 lines (127 loc) · 8.74 KB

README.md

File metadata and controls

159 lines (127 loc) · 8.74 KB
Raw

Dyssol

Dyssol is a tool for dynamic flowsheet simulation of complex production processes with advanced treatment of granular materials.

To contact developers, visit dyssoltec.com.

For more information and documentation, check dyssoltec.github.io.

Video introductions: Basics and Simulation of granulation process.

New versions and updates on our github page.

To cite Dyssol please use the following:

  • Skorych, V., Dosta, M., Hartge, E.-U., Heinrich, S. (2017). Novel system for dynamic flowsheet simulation of solids processes. Powder Technology, 314, 665-679. doi.org/10.1016/j.powtec.2017.01.061.
  • Skorych, V., Dosta, M., Heinrich, S. (2020). Dyssol — An open-source flowsheet simulation framework for particulate materials. SoftwareX, 12, 100572. doi.org/10.1016/j.softx.2020.100572.

Dyssol® is a registered trade mark of DyssolTEC GmbH.

Installation on Windows

Dyssol should install and work on all latest versions of Windows. Requires Visual C++ Redistributable for Visual Studio 2019 to run. To install, run the installer and follow the instructions.

Compilation on Windows

Compilation requirements on Windows

Build on Windows

  • Make sure all programs and tools from the list are installed.
  • Setup Qt Visual Studio Tools extension to point to the installed Qt libraries. In Visual Studio 2019, go to Extensions → Qt VS Tools → Qt Versions → add new Qt version → ... → Navigate in the Qt installation directory to Qt/5.15.0/msvc2019/bin/qmake.exe → rename Version to msvc2019 → OK. Repeat for Qt/5.15.0/msvc2019_64/bin/qmake.exe and rename Version to msvc2019_64.
  • Compile and build external libraries: HDF5, graphviz, SUNDIALS, zlib. To do this, navigate to Dyssol/ExternalLibraries/ and execute file RunAll.bat. It will start building all the required libraries by executing files CompileZLib.ps1, CompileHDF5.ps1, CompileSundials.ps1, etc. To use the scripts, the following requirements apply: Visual Studio 16 2019, CMake, PowerShell 5.0.
  • Open Dyssol/Dyssol.sln with Visual Studio and build the solution.

Build documentation and installers on Windows

  • Install Doxygen.
  • Install MikTeX with packages: amscls, anyfontsize, preview, zhmetrics. With default installation, MikTeX will install the packages on-the-fly during the first build of the documentation (user confirmation may be required).
  • Install required python libraries by running in terminal
py -m ensurepip --upgrade
pip install -U sphinx sphinx-rtd-theme breathe
  • In Visual Studio Solution Explorer go to Installers, right click on the Installer project and choose Build. The built .exe installer locates in Dyssol/DyssolInstallers/Installers.

Also, other versions of Microsoft Visual Studio can be used, but additional preparations may be required:

  • Install build tools for the corresponding Visual Studio.
  • Configure all *.ps1 scripts to use the required version of Visual Studio build tools before running Dyssol/ExternalLibraries/RunAll.bat.
  • If the Models Creator SDK tool is required, files associated with it may need to be updated. They to be found in Dyssol/DyssolInstallers/Data/ModelsCreatorSDK/.

Compilation on Linux

Compilation requirements on Linux

  • gcc-9, g++-9
  • CMake 3.1.0 or higher

Build on Linux

Ubuntu 20/22

cd /path_to_repo
sudo add-apt-repository ppa:gladky-anton/sundials
sudo apt install build-essential cmake libsundials-dev libhdf5-serial-dev libqt5opengl5-dev libgraphviz-dev doxygen python3-sphinx python3-sphinx-rtd-theme python3-breathe texlive-latex-extra
mkdir install
mkdir build
cd build
cmake .. -DCMAKE_CXX_COMPILER=g++ -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../install
cmake --build . --parallel
make doc
make install

Debian 12

cd /path_to_repo
sudo apt install build-essential cmake libsundials-dev libhdf5-serial-dev libqt5opengl5-dev libgraphviz-dev doxygen python3-sphinx python3-sphinx-rtd-theme python3-breathe texlive-latex-extra
mkdir install
mkdir build
cd build
cmake .. -DCMAKE_CXX_COMPILER=g++ -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=../install
cmake --build . --parallel
make doc
make install

The compiled executable file and all the units' libraries will appear in /path_to_repo/install

Code organization

  • BaseSolvers - interfaces for equation solvers
  • CahceHandlers - dynamic data caching
  • Documentation - manuals
  • DyssolCLI - main project for command-line version of Dyssol
  • DyssolGUI - main project for GUI version of Dyssol
  • DyssolInstallers - scripts and data needed to build installers for Windows
  • EquationSolvers - built-in equation solvers based on SUNDIALS library
  • ExternalLibraries - all third-party libraries and scripts to build them
  • GUIDialogs - main GUI components
  • GUIWidgets - auxiliary GUI components and tools
  • HDF5Handler - wrapper for HDF5 library
  • MaterialsDatabase - database of materials
  • ModelsAPI - part of the core components needed to develop units
  • Modules - additional modules
  • PropertySheets - projects settings for Visual Studio
  • SimulatorCore - core components
  • Solvers - all solvers and templates for them
  • Units - all units and templates for them
  • Utilities - auxiliary program components
  • Dyssol.sln - main file of the Visual Studio solution
  • LICENSE - license agreement
  • Materials.dmdb - exemplary database of materials
  • README.md - this file

Installation directory organization

  • Example flowsheets – flowsheet examples
  • Example solvers – source code of solvers (C++)
  • Example units – source code of units (C++)
  • Help – documentation files (pdf)
  • Licenses – information about licenses
  • platforms - Qt libraries to support GUI
  • Solvers – libraries of developed solvers
  • styles - Qt libraries to support GUI
  • Units – libraries of developed units
  • ModelsCreatorSDK – Models Creator tool: template project for Microsoft Visual Studio
  • Dyssol.exe – main executable of Dyssol
  • DyssolC.exe – command-line utility
  • ExampleConfigFile.txt – example configuration file for command-line utility
  • LICENSE - license agreement
  • Materials.dmdb – default materials database
  • Qt5*.dll - Qt libraries to support GUI
  • *.dll - Other external libraries
  • unins000.exe – Dyssol uninstaller

Third-party tools and libraries