Welcome to geoparticle’s documentation!

Geoparticle is a Python package for geometry construction in particle-based simulation. I mainly use this package for geometry construction in LAMMPS; of course, it can also be used for other softwares.

Contents

• Installation
• Background
• Gallery
• Tutorials
  • Tutorial 1: Create 2D dam break
  • Tutorial 2: Create a 3D intestine connected with an inlet and and outlet
• Limitations
• Class topology
• API Reference
  • Base module
  • Shapes module
  • Operations module
  • Utility functions

Useful links

GitHub repository: https://github.com/Jasmine969/geoparticle

PyPI page: https://pypi.org/project/geoparticle/

About the author

Hi, my name is Hong Zhu. I am currently studying for a doctor’s degree in Soochow University, China. I am interested in particle-based simulation. This is my ResearhGate Homepage. For any question or suggestion regarding geoparticle, please post it at GitHub issues page.