ansys-rocky-core 0.1.0

Python client library for Ansys Rocky

PyRocky is a Python client library for remotely controlling Ansys Rocky, which is the most powerful software in the market for performing DEM (discrete element method) simulations.

Documentation and issues

Documentation for the latest stable release of PyRocky is hosted at PyRocky documentation.

The documentation has five sections:

• Getting started: Learn how to install PyRocky in user mode and then launch it.

• User guide: Understand how to use the Rocky PrePost API with PyRocky.

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

• Examples: Explore end-to-end examples that show how to use PyRocky.

• Contribute: Learn how to contribute to the PyRocky codebase or documentation.

In the upper right corner of the documentation’s title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.

On the PyRocky Issues page, you can create issues to report bugs and request new features. On the Discussions page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

To reach the PyAnsys project support team, email PyAnsys Core team.

License

PyRocky is licensed under the MIT License.

PyRocky makes no commercial claim over Ansys whatsoever. This library extends the functionality of Ansys Rocky by adding a Python interface without changing the core behavior or license of the original software. The use of PyRocky requires a legally licensed copy of Ansys Rocky.

To get a copy of Ansys Rocky, see the Ansys Rocky page on the Ansys website.