Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iAniket23 authored Nov 14, 2024
1 parent 352cd07 commit 7fcf841
Showing 1 changed file with 46 additions and 6 deletions.
52 changes: 46 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,64 @@
![Python Version](https://img.shields.io/badge/python-3.8%2B-blue)
![License](https://img.shields.io/badge/license-MIT-green)
![PyPI version](https://badge.fury.io/py/fissionmunk.svg)
[![API Reference](https://img.shields.io/badge/API%20Reference-Docs-blue)](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

Expand All @@ -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)

0 comments on commit 7fcf841

Please sign in to comment.