Skip to content

Commit 81de242

Browse files
committed
Add example video
1 parent f717043 commit 81de242

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313
ParticlesMC is a Julia package for performing atomic and molecular Monte Carlo simulations. It is designed to be efficient and user-friendly, making it suitable for both research and educational purposes. Built on top of the <a href="https://github.com/TheDisorderedOrganization/Arianna.jl"> Arianna </a> module, it leverages Arianna’s Monte Carlo framework.
1414
</p>
1515

16+
![MC simulation of a 2D liquid](./data/movie/movie.mp4)
17+
This example can be reproduced by running `particlesmc params.toml` in the `data/movie/` folder . Movie generated with [OVITO](https://www.ovito.org/)
1618
## Features
1719

1820
- **Flexible execution**: Simulations can be run from standalone scripts or through a command-line interface (CLI), enabling easy integration into workflows.
@@ -21,6 +23,7 @@ ParticlesMC is a Julia package for performing atomic and molecular Monte Carlo s
2123
- **Computational efficiency**: Designed with performance in mind to enable fast simulations.
2224
- **Arianna framework integration**: Leverages the [Arianna](https://github.com/TheDisorderedOrganization/Arianna.jl) Monte Carlo framework, benefiting from advanced techniques such as Policy-Guided Monte Carlo (PGMC) and parallel tempering (soon).
2325

26+
2427
## Installation
2528

2629
### Requirements

0 commit comments

Comments
 (0)