Skip to content

Commit 9eca63e

Browse files
committed
updated README
1 parent d4c6595 commit 9eca63e

3 files changed

Lines changed: 78 additions & 1 deletion

File tree

.dependencies/.github

README.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
<!--
2+
WARNING: DO NOT MODIFY DIRECTLY THE README.md!
3+
This README.md file was assembled using the sed command from the files listed in
4+
"files.txt". See the script in "generateREADME.sh". To modify the content of
5+
the README.md, modify the files listed in "files.txt", or add a new file to the
6+
list in "files.txt".
7+
-->
8+
9+
10+
# A Set of Tutorials for the LAMMPS Simulation Package
11+
12+
This article introduces a suite of tutorials designed to make learning LAMMPS
13+
more accessible to new users.
14+
15+
## Tutorials
16+
17+
- Tutorial 1: Lennard-Jones fluid
18+
- Tutorial 2: Pulling on a carbon nanotube
19+
- Tutorial 3: Polymer in water
20+
- Tutorial 4: Nanosheared electrolyte
21+
- Tutorial 5: Reactive silicon dioxide
22+
- Tutorial 6: Water adsorption in silica
23+
- Tutorial 7: Free energy calculation
24+
- Tutorial 8: Reactive Molecular Dynamics
25+
26+
## Input files
27+
28+
All the input files from the tutorials can be found in the
29+
[**files/**](files/) folder. The Python scripts used to generate the plots
30+
are also provided.
31+
32+
For each tutorial, a `.manifest` file lists all the files required to
33+
follow the tutorial. These files can be downloaded from the LAMMPS-GUI by
34+
selecting `Start Tutorial X`. The solutions to the tutorials are provided
35+
within the solution repository located in each tutorial folder.
36+
37+
## PDF
38+
39+
Access the last version of the `.pdf` from
40+
[the Actions tab](https://github.com/lammpstutorials/lammpstutorials-article/actions/runs/12458522247/artifacts/2354075042) here on GitHub,
41+
or clone this repository and compile the `.tex` file yourself by typing in a terminal:
42+
43+
```
44+
make
45+
```
46+
This will generate the `.pdf` version of the tutorial. Ensure you have LaTeX and the necessary dependencies installed on your system before attempting to compile.
47+
48+
## Contributing
49+
50+
We welcome contributions to improve the tutorials. If you encounter any issues, have suggestions, or want to ask questions, please open an issue in this repository. You can also contribute by submitting a pull request to improve the tutorials or fix any bugs.
51+
Your feedback and contributions help make the tutorials more useful for everyone.
52+
53+
## License
54+
55+
This project is licensed under the Creative Commons Attribution 4.0 International License. This license covers all the input [**files/**](files/) and tutorial content. For more details, see the [LICENSE](LICENSE) file.
56+
57+
## Authors
58+
59+
- [Simon Gravelle](https://github.com/simongravelle) (corr. author),
60+
Université Grenoble Alpes, CNRS, LIPhy, 38000 Grenoble, France.
61+
- [Jacob R. Gissinger](https://www.stevens.edu/profile/jgissing),
62+
Stevens Institute of Technology, Hoboken, NJ 07030, USA.
63+
- [Axel Kohlmeyer](https://sites.google.com/site/akohlmey),
64+
Institute for Computational Molecular Science, Temple University, Philadelphia,
65+
PA 19122, USA.
66+
67+
68+
69+
## Acknowledgements
70+
71+
- Simon Gravelle acknowledges funding from the European Union's Horizon 2020
72+
research and innovation programme under the Marie Skłodowska-Curie grant
73+
agreement N°101065060.
74+
- Axel Kohlmeyer acknowledges financial support from Sandia National Laboratories
75+
under POs 2149742 and 2407526.
76+
77+

0 commit comments

Comments
 (0)