squish/README.rst

Squish: Soft Packing Simulations

Squish is a Python library that handles simulations for the flow of 'soft' or 'compressible' objects, under some energy in a periodic domain. The gradient flow of the objects are simulated and is able to be saved and rendered into diagrams. Squish also provides simple to use scripts for basic usage, as well as a simple API for more advanced functionality.

Fast parallelized Cython code is used to compute the simulations efficienctly. Also, NumPy arrays are used, enabling easy integratation with the standard scientific Python ecosystem.

Resources

• Documentation: Examples, guides, and Squish API.
• GitHub repository: View and download the Squish source code.
• Issue tracker: Report issues or request features for Squish.

Installation

The simplest way to install Squish is to use pip:

(.venv) /path/to/squish: pip install squish

Research Data

The data for used for the publication "Defects and frustration in the packing of soft balls" can be found here.

License

This project uses GNU AGPLv3.0.

Support and Contribution

Feel free to visit our repository on GitHub for source code of this library. Any issues or bugs may be reported at the issue tracker. All contributions to Squish are welcome!