Getting Started

Contents:

• Installation Instructions
  • Requirements
  • Installing from PyPI
  • Other Requirements
• Quick Start
  • Creating a Network
  • Adding Geometrical Properties
  • Creating Phases
  • Assigning Pore-Scale Physics Models
  • Performing Some Simulations
  • Saving Project and Exporting to Paraview
• Examples
  • OpenPNM-Examples Repository on Github
• Using Paraview to Visualize Output
  • Export a VTK File from OpenPNM
  • Open the VTK file created by OpenPNM
  • Plot the Dore Data
  • Plot the Throat Data
• Migrating from V1 to V2
  • Renaming Modules, and Reorganizing
  • Cleaning up Classes
  • Instantiating Physics Objects
  • Object Lookups
  • Dealing with Pore-Scale Models
  • Other Breaking Changes