SPHinXsim

Project status

Repository Description

The Python and LLM UI for the multi-physics library SPHinXsys.

Highlights

• Simulation building system accepting structured Jason as single source of truth
• Jason interface directly used for the C++ based simulator
• Optional Python interface using pybind11
• Optional Natural Language (CLI) interface based on Pydantic and Schema validations
• Pyvista visualization (CLI interface) for simulation settings
• Full support for heterogeneous computing with CPU and GPU using SYCL

Installation, tutorial and documentation

SPHinXsim is cross-platform can be compiled and used in Windows, Linux and McOS systems.

For installation, program manual and tutorials, please check at https://xiangyu-hu.github.io/SPHinXsim/.

Interaction with SPHinXsim and the team

Thank you for using and supporting our open-source project! We value each feedback.

For SPHinXsim users

Your input is crucial to us. We encourage you to report any issues you encounter with the library, including:

• Bug reports
• Interface improvement suggestions, such as API design, visualization, documentation, and user experience
• Feature requests
• General feedback on your experience with SPHinXsim

We particularly appreciate feedback stemming from practical simulations or projects, as these insights are essential for improving SPHinXsim.

For SPHinXsim developers

If you don't have a GitHub account yet, please register for one. Fork the SPHinXsim repository to add new features or improve existing ones. Once your changes are ready, commit them and initiate a pull request to have your contributions merged into the main repository.

To ensure efficient and effective development, we prioritize addressing issues raised by active contributors—whether through code, documentation, or other means. We welcome any interaction with SPHinXsim and our team.

You can also join us as a collaborator, enabling you to branch directly within the main repository and review pull requests.

Together, we can build a leading-edge multi-physics simulator open for all!

If you have any further question, please contact xiangyu.hu@tum.de.