Skip to content

Commit 0465b6f

Browse files
committed
New logo + complete README
1 parent 43b7c26 commit 0465b6f

3 files changed

Lines changed: 52 additions & 12 deletions

File tree

CITATION.bib

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
@software{Arianna,
2+
author = {Galliano, Leonardo and Simon, Romain},
3+
title = {{Arianna.jl}},
4+
url = {https://github.com/TheDisorderedOrganization/ParticlesMC.jl},
5+
year = {2025}
6+
}

README.md

Lines changed: 46 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,52 @@
1-
<div align="center">
1+
<h1 align="center">
2+
<img src="particlesmc_logo.png" width="500"/>
3+
</h1>
24

3-
# ParticlesMC
4-
[![License](https://img.shields.io/badge/license-GPL%203.0-red.svg)](https://github.com/TheDisorderedOrganization/MCMC/blob/main/LICENSE)
5-
[![codecov](https://codecov.io/gh/TheDisorderedOrganization/ParticlesMC/graph/badge.svg?token=USGU6ANY03)](https://codecov.io/gh/TheDisorderedOrganization/ParticlesMC)
5+
<div align="center">
66

7-
<img src="mcmc_logo.png" alt="mcmc" width="200"/>
7+
[![license](https://img.shields.io/badge/license-GPL%203.0-red.svg)](https://github.com/TheDisorderedOrganization/ParticlesMC/blob/main/LICENSE)
8+
[![ci](https://github.com/TheDisorderedOrganization/ParticlesMC/actions/workflows/ci.yml/badge.svg)](https://github.com/TheDisorderedOrganization/ParticlesMC/actions/workflows/ci.yml)
9+
[![codecov](https://codecov.io/gh/TheDisorderedOrganization/Arianna.jl/graph/badge.svg?token=URGL1HJOOI)](https://codecov.io/gh/TheDisorderedOrganization/ParticlesMC)
810
</div>
911

12+
<p align="center">
13+
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.
14+
</p>
1015

11-
## Overview
12-
13-
With the `ParticlesMC` module you can run atomic / molecular Monte Carlo simulations. It is built on top of the `Arianna` module.
16+
## Features
1417

18+
- **Flexible execution**: Simulations can be run from standalone scripts or through a command-line interface (CLI), enabling easy integration into workflows.
19+
- **Interaction potentials**: Supports a broad range of interatomic and intermolecular interaction potentials.
20+
- **Monte Carlo moves**: Implements state-of-the-art Monte Carlo moves for both atomic and molecular simulations.
21+
- **Computational efficiency**: Designed with performance in mind to enable fast simulations.
22+
- **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).
1523

1624
## Installation
1725

18-
Write code
26+
### Requirements
27+
- Julia version 1.9 or higher
28+
29+
### Installing ParticlesMC
30+
After the 1st release, you will be able to install ParticlesMC using the Julia package manager in one of two ways:
31+
32+
1. Using the package mode (press `]` in the Julia REPL):
33+
```julia
34+
add ParticlesMC
35+
```
36+
37+
2. Using the Pkg API:
38+
```julia
39+
using Pkg
40+
Pkg.add("ParticlesMC")
41+
```
42+
43+
### Building ParticlesMC
44+
45+
I you want to build `ParticlesMC`, enter the package mode (press `]` in the Julia REPL) and type:
46+
```julia
47+
build
48+
```
49+
This will build the `particlesmc` executable at `~/.julia/bin` (please add this path to your PATH).
1950

2051
## Usage
2152

@@ -27,14 +58,17 @@ Add example code
2758
```julia
2859
```
2960

30-
3161
## Contributing
3262

33-
We welcome contributions from the community. If you have a new feature to add, please fork the repository, make your changes, and submit a pull request.
63+
We welcome contributions from the community. If you have a new system or feature to add, please fork the repository, make your changes, and submit a pull request.
64+
65+
## Citing
66+
67+
If you use Arianna in your research, please cite it! You can find the citation information in the [CITATION](https://github.com/TheDisorderedOrganization/ParticlesMC/blob/main/CITATION.bib) file or directly through GitHub's "Cite this repository" button.
3468

3569
## License
3670

37-
This project is licensed under the GNU General Public License v3.0. License. See the [LICENSE](LICENSE) file for details.
71+
This project is licensed under the GNU General Public License v3.0. License. See the [LICENSE](https://github.com/TheDisorderedOrganization/ParticlesMC/blob/main/LICENSE) file for details.
3872

3973
## Contact
4074

particlesmc_logo.png

77.7 KB
Loading

0 commit comments

Comments
 (0)