PyRocky
#######

PyRocky is a Python client library to create, run, and postprocess
particle dynamics simulations using `Ansys Rocky <https://www.ansys.com/products/fluids/ansys-rocky>`_,
the most powerful DEM (discrete element method) software in the market.


.. grid:: 2
   :gutter: 2 3 3 4

   .. grid-item-card:: Getting started :material-regular:`start`
      :padding: 2 2 2 2
      :link: getting_started/index
      :link-type: doc

      Learn how to install PyRocky in user mode and then launch it.

   .. grid-item-card:: User guide :material-regular:`book`
      :padding: 2 2 2 2
      :link: user_guide/index
      :link-type: doc

      Understand how to use the Rocky PrePost API with PyRocky.


.. grid:: 2
   :gutter: 2 3 3 4

   .. grid-item-card:: API reference :material-regular:`terminal`
      :padding: 2 2 2 2
      :link: api/index
      :link-type: doc

      Understand PyRocky API endpoints, their capabilities, and how to interact with them programmatically.

   .. grid-item-card:: Examples :material-regular:`code`
      :padding: 2 2 2 2
      :link: examples/index
      :link-type: doc

      Explore end-to-end examples that show how to use PyRocky.

.. toctree::
   :hidden:
   :maxdepth: 3
.. toctree::
   :hidden:
   :maxdepth: 3

   getting_started/index
   user_guide/index
   api/index
   examples/index
   contributing