-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
46 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,24 +3,64 @@ | |
 | ||
 | ||
 | ||
[](https://ianiket23.github.io/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](http://www.pymunk.org/) library. | ||
|
||
2024, Aniket Mishra - [[email protected]](https://ianiket23.github.io/) | ||
|
||
- Website: | ||
- Documentation: | ||
- Documentation: [https://ianiket23.github.io/FissionMunk/](https://ianiket23.github.io/FissionMunk/) | ||
- Source code: [https://github.com/iAniket23/fissionmunk](https://github.com/iAniket23/fissionmunk) | ||
- Contributing: | ||
- Bug reports: [https://github.com/iAniket23/fissionmunk/issues](https://github.com/iAniket23/fissionmunk/issues) | ||
- Report a security vulnerability: | ||
|
||
## Installation | ||
## Features | ||
- Interactive Simulation: Visualize neutron interactions with uranium in real-time, with configurable parameters. | ||
- Modularity: Use customizable modules to add moderators, control rods, and other reactor elements. | ||
- Educational Tool: Ideal for students and educators to explore nuclear fission mechanics. | ||
- Open-Source: Fully open-source and extensible for customization and additional functionality. | ||
|
||
## Getting Started with FissionMunk | ||
FissionMunk makes it easy to simulate and visualize nuclear fission dynamics. To get started, follow these steps: | ||
|
||
### Installation | ||
|
||
To install FissionMunk, use `pip`: | ||
```bash | ||
pip install fissionmunk | ||
``` | ||
### Set Up Your First Simulation | ||
Now that you’ve installed FissionMunk, let's create a basic simulation. Here's an example to help you get started: | ||
|
||
#### Example: Basic Fission Simulation | ||
```python | ||
import pygame | ||
|
||
from fissionmunk import Core | ||
from fissionmunk import Moderator | ||
from fissionmunk import ControlRod | ||
from fissionmunk import Fuel | ||
from fissionmunk import Water | ||
from fissionmunk import Material | ||
from fissionmunk import Mechanics | ||
``` | ||
```python | ||
# Initialize Pygame | ||
pygame.init() | ||
display = pygame.display.set_mode((700, 600)) | ||
clock = pygame.time.Clock() | ||
FPS = 60 | ||
``` | ||
|
||
### Documentation Overview | ||
The following modules are included in FissionMunk and offer various simulation controls: | ||
|
||
- Core: Manages the main simulation environment and fuel elements. | ||
- ControlRod: Controls neutron absorption, allowing for fission rate adjustments. | ||
- Moderator: Slows down neutrons to maintain optimal reaction rates. | ||
- FuelElement: Represents fuel elements, such as uranium atoms, in the simulation. | ||
- Neutron: Models individual neutrons and their interactions. | ||
|
||
Refer to the full documentation for module-specific details and usage examples. | ||
|
||
## Contributing | ||
|
||
|
@@ -38,4 +78,4 @@ If you're planning on making a major change or addition, please **open an issue* | |
Thank you for contributing! | ||
|
||
## License | ||
[MIT License](LICENSE) | ||
[MIT License](LICENSE) |