{"id":15097635,"url":"https://github.com/surtecha/multi-physics-simulation-engine","last_synced_at":"2025-04-14T22:24:32.778Z","repository":{"id":242260978,"uuid":"803612936","full_name":"surtecha/multi-physics-simulation-engine","owner":"surtecha","description":"A real world physics simulation application built with python","archived":false,"fork":false,"pushed_at":"2024-07-16T06:27:55.000Z","size":7146,"stargazers_count":1,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-27T14:18:33.905Z","etag":null,"topics":["jax","numpy","physics","pygame","python","scipy","simulation"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/surtecha.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-21T04:09:57.000Z","updated_at":"2025-01-03T10:40:07.000Z","dependencies_parsed_at":"2024-06-01T20:11:12.069Z","dependency_job_id":"73977b47-e97e-4dad-9964-e479b335f906","html_url":"https://github.com/surtecha/multi-physics-simulation-engine","commit_stats":{"total_commits":50,"total_committers":6,"mean_commits":8.333333333333334,"dds":"0.42000000000000004","last_synced_commit":"cc3fb3f2ab17aa272b1cbc077e2812a314dfbae8"},"previous_names":["surtecha/multi-physics-simulation-engine"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surtecha%2Fmulti-physics-simulation-engine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surtecha%2Fmulti-physics-simulation-engine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surtecha%2Fmulti-physics-simulation-engine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surtecha%2Fmulti-physics-simulation-engine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/surtecha","download_url":"https://codeload.github.com/surtecha/multi-physics-simulation-engine/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248970130,"owners_count":21191377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jax","numpy","physics","pygame","python","scipy","simulation"],"created_at":"2024-09-25T16:24:26.191Z","updated_at":"2025-04-14T22:24:32.758Z","avatar_url":"https://github.com/surtecha.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/surtecha/multi-physics-simulation-engine/assets/91011302/c01a2393-45a0-4ad7-8899-e883aeaa90bd\" alt=\"MPSE logo\" width=\"200\" height=\"200\"/\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eMulti-Physics Simulation Engine\u003c/h1\u003e\n\n## Table of Contents\n\n- [Overview](#overview)\n- [Features](#features)\n- [Getting Started](#getting-started)\n    - [Installation](#installation)\n    - [Requirements](#requirements)\n    - [Running the Application](#running-the-application)\n- [Project Structure](#project-structure)\n- [Usage](#usage)\n    - [Interface](#interface)\n    - [Adding New Simulations](#adding-new-simulations)\n    - [Example](#example)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Overview\n\nThe Multi-Physics Simulation Engine is a comprehensive application designed to facilitate the exploration and simulation of various physical phenomena. The application provides an intuitive and user-friendly interface for running simulations in multiple categories such as Atomics, Fluids, Kinematics, Gravitation, and Materials. Each category contains a set of predefined simulations that users can easily run and visualize.\n\n## Features\n\n- **Multi-Category Support**: Simulate physical phenomena across diverse categories including Atomics, Fluids, Kinematics, Gravitation, and Materials.\n- **User-Friendly Interface**: A modern, dark-themed GUI with categorized tabs for easy navigation.\n- **Dynamic Simulation Loading**: Simulations are dynamically loaded and executed, allowing for easy extension and customization.\n- **Detailed Descriptions**: Each simulation comes with a detailed description to help users understand the underlying concepts.\n- **High-Quality Visualization**: Buttons and icons are designed for high-quality display with rounded, smooth transformations.\n\n## Getting Started\n\n### Installation\n\n1. **Clone the repository**:\n    ```sh\n    git clone https://github.com/surtecha/multi-physics-simulation-engine.git\n    cd multi-physics-simulation-engine\n    ```\n\n2. **Install the required Python packages**:\n    ```sh\n    pip install -r requirements.txt\n    ```\n\n### Requirements\n\nEnsure the following packages are listed in your `requirements.txt` file:\n\n```\njax==0.4.28\njaxlib==0.4.28\nmatplotlib==3.9.0\nmatplotlib-inline==0.1.7\nnumpy==1.26.4\nphiflow==2.5.4\nphiml==1.5.1\npillow==10.3.0\npygame==2.5.2\npymunk==6.8.0\nPyQt5==5.15.10\nPyQt5-Qt5==5.15.13\nPyQt5-sip==12.13.0\npytz==2024.1\nPyYAML==6.0.1\npyzmq==26.0.3\nqtconsole==5.5.2\nQtPy==2.4.1\nsympy==1.12\ntqdm==4.66.4\n```\n\n### Running the Application\n\nTo start the application, navigate to the project directory and run the following command:\n\n```sh\npython main.py\n```\n\nThe application will launch and display the main window with tabs for each simulation category.\n\n## UI Preview\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/surtecha/multi-physics-simulation-engine/assets/91011302/496f5d4b-c4dd-4791-83df-e8579e506780\" alt=\"Starting window upon launching (Atomics section)\" width=\"600\"/\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  Starting window upon launching (Atomics section)\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/surtecha/multi-physics-simulation-engine/assets/91011302/74fde5d3-c209-4b59-b7b7-f72b4e88ab7c\" alt=\"Description of simulation displayed when clicked\" width=\"600\"/\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  Description of simulation displayed when clicked\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/surtecha/multi-physics-simulation-engine/assets/91011302/6b690cee-3953-4768-a33b-bdfe2546b3b3\" alt=\"Simulation window\" width=\"600\"/\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  Simulation window\n\u003c/p\u003e\n\n## Project Structure\n\n- **main.py**: The main application script that initializes the GUI and handles user interactions.\n- **/Atomics**: Directory containing atomic simulations and their resources.\n- **/Fluids**: Directory containing fluid simulations and their resources.\n- **/Kinematics**: Directory containing kinematic simulations and their resources.\n- **/Gravitation**: Directory containing gravitational simulations and their resources.\n- **/Materials**: Directory containing material simulations and their resources.\n- **logo.jpg**: The application icon.\n\nEach directory contains python scripts, images, and description files for respective simulations.\n\n## Usage\n\n### Interface\n\nUpon launching the application, you will see a window with tabs representing different categories of simulations. Each tab contains buttons for individual simulations. \n\n1. **Select a Category**: Click on the tab corresponding to the category of interest (e.g., Kinematics).\n2. **Choose a Simulation**: Click on the button representing the simulation you want to run.\n3. **View Description**: A popup will appear showing a description of the simulation. \n4. **Run Simulation**: Click the \"Simulate\" button in the popup to run the simulation.\n\n### Adding New Simulations\n\nTo add a new simulation:\n\n1. **Create the Simulation Script**: Write your simulation code in a Python script and place it in the appropriate category directory (e.g., `/Kinematics`).\n2. **Add a Description**: Create a text file with the same name as your script (e.g., `your_simulation_description.txt`) and write a description of the simulation.\n3. **Add an Image (Optional)**: Add an image with the same name as your script (e.g., `your_simulation.jpg`) to be used as the button icon.\n\n### Example\n\nIf you have a new simulation called `projectile.py` for the Kinematics category:\n\n1. Place `projectile.py` in the `/Kinematics` directory.\n2. Create `projectile_description.txt` with a description of the simulation.\n3. (Optional) Add `projectile.jpg` for the button icon.\n\n## Contributing\n\nPlease read the `CONTRIBUTING.md` file for detailed instructions on contributing to the project.\n\n## License\n\nThis project is licensed under the MIT License. See the `LICENSE` file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurtecha%2Fmulti-physics-simulation-engine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsurtecha%2Fmulti-physics-simulation-engine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurtecha%2Fmulti-physics-simulation-engine/lists"}