fissionmunk 0.0.1

FissionMunk is a lightweight 2D physics open source python library designed to simulate nuclear fission reactor mechanics.

FissionMunk

FissionMunk is a lightweight 2D physics open source python library designed to simulate nuclear fission reactor mechanics. It enables users to visualize interactions between neutrons and uranium atoms, providing valuable insights into fission dynamics with customizable parameters, such as neutron occurrence probabilities, moderators, and control rods. FissionMunk is ideal for educational simulations, nuclear physics research, and interactive demos, and is built on top of the Pymunk library.

2024, Aniket Mishra - [e-mail]

• Website:
• Documentation:
• Source code: https://github.com/iAniket23/fissionmunk
• Contributing:
• Bug reports: https://github.com/iAniket23/fissionmunk/issues
• Report a security vulnerability:

Installation

To install FissionMunk, use pip:

pip install fissionmunk

Contributing

We welcome contributions to the FissionMunk project! If you'd like to contribute, please follow these steps:

1. Fork this repository to your own GitHub account.
2. Create a new branch from the main branch for your feature or fix. You can name the branch something descriptive, like feature/your-feature-name.
3. Commit your changes with clear and concise commit messages.
4. Push your branch to your forked repository.
5. Open a pull request (PR) to the main repository. Be sure to provide a description of the changes you've made.

Major Changes

If you're planning on making a major change or addition, please open an issue first to discuss your ideas with the maintainers before starting on the implementation. This helps ensure that your changes align with the project's goals.

Thank you for contributing!

License

MIT License