Skip to content

Commit aa15772

Browse files
committed
Tweaks to documentation mainpage
1 parent b56d56d commit aa15772

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

docs/mainpage.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## BraWl: Simulating the thermodynamics and phase stability of multicomponent alloys using conventional and enhanced sampling techniques
1+
## Simulating the thermodynamics and phase stability of multicomponent alloys using conventional and enhanced sampling techniques
22

33
The Fortran package **BraWl** (named after the Bragg-Williams model) facilitates simulation of the thermodynamics and phase stability of both binary and multicomponent alloys. It achieves this by providing implementation of both the Bragg-Williams Hamiltonian (a lattice based model expressing the internal energy of an alloy as a sum of atom-atom effective pair interactions) concurrently with a range of conventional and enhanced sampling techniques for exploration of the alloy configuration space. The result is a package which can determine phase equilibria as a function of both temperature and alloy composition, which leads to the construction of alloy phase diagrams. Additionally, the package can be used for extraction of representative equilibrated atomic configurations for visualisation, as well as for use in complementary modelling approaches. It provides a lightweight, fast and flexible foundation for a range of simulations relating to alloy thermodynamics and phase diagrams.
44

@@ -60,13 +60,26 @@ A (hopefully fairly complete) list of publications obtained using the package is
6060
---
6161

6262
## Contributing
63-
Any/all contributions are welcome via pull requests.
63+
64+
Contributions are welcome via pull requests.
65+
66+
Features which are particularly welcome are:
67+
- Implementations of new lattice types.
68+
- Implementations of new/interesting sampling algorithms.
69+
- Interfaces with other packages, _e.g._ writing output configurations to formats specific to other materials simulation codes.
70+
71+
Features which we do not currently plan on implementing are:
72+
- Anything off-lattice. (The way configurations are represented internally would make this challenging!)
73+
74+
Additionally, as [developer documentation for the package](https://chriswoodgate.github.io/BraWl/) is auto-generated using [Doxygen](https://www.doxygen.nl), we ask that all contributions to the codebase follow the [Doxygen guide for formatting comment blocks](https://www.doxygen.nl/manual/docblocks.html#fortranblocks) and uses the relevant [Doxygen commands](https://www.doxygen.nl/manual/commands.html) to specify the details of new features/routines.
75+
6476

6577
---
6678

6779
## 🪪 License
6880

6981
This software is released under the LGPL-3.0 license. See the file LICENSE.txt for details.
82+
7083
---
7184

7285
## 🧭 Documentation Guide

0 commit comments

Comments
 (0)