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

.. toctree::
   :maxdepth: 2
   :titlesonly:

   installation
   background
   gallery
   tutorials
   limitations
   topo
   api_reference

================
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 <https://www.researchgate.net/profile/Hong-Zhu-76>`_.
For any question or suggestion regarding geoparticle, please post it at `GitHub issues page <https://github.com/Jasmine969/geoparticle/issues>`_.