Skip to content

Commit 6a4c6d1

Browse files
simongravellesimongravelle
committed
added shared README section
1 parent 7c78d39 commit 6a4c6d1

File tree

7 files changed

+101
-24
lines changed

7 files changed

+101
-24
lines changed

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "dependencies/.github"]
2+
path = dependencies/.github
3+
url = git@github.com:lammpstutorials/.github.git

‎AUTHORS.md‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎DESCRIPTION.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# LAMMPS tutorials
2+
3+
This is the repository of the [LAMMPS tutorials](https://lammpstutorials.github.io/)
4+
webpage. All the LAMMPS input scripts and data files can be found in a separate
5+
repository named [lammpstutorials-inputs](https://github.com/lammpstutorials/lammpstutorials-inputs).
6+
7+
The tutorials are compatible with the XXXX2024 release of LAMMPS.
8+
9+
## About LAMMPS tutorials
10+
11+
The LAMMPStutorials website is made of seven tutorials that are ordered by increasing difficulty.
12+
[Lennard-Jones fluid](https://lammpstutorials.github.io/sphinx/build/html/tutorials/level1/lennard-jones-fluid.html)
13+
is meant for absolute LAMMPS and molecular dynamics beginners, and the complexity of the simulation is
14+
progressively increased for [Pulling on a carbon nanotube](https://lammpstutorials.github.io/sphinx/build/html/tutorials/level1/breaking-a-carbon-nanotube.html),
15+
[Polymer in water](https://lammpstutorials.github.io/sphinx/build/html/tutorials/level2/polymer-in-water.html),
16+
[Nanosheared electrolyte](https://lammpstutorials.github.io/sphinx/build/html/tutorials/level2/nanosheared-electrolyte.html),
17+
and [Reactive silicon dioxide](https://lammpstutorials.github.io/sphinx/build/html/tutorials/level3/reactive-silicon-dioxide.html).
18+
Finally, [Water adsorption in silica](https://lammpstutorials.github.io/sphinx/build/html/tutorials/level3/water-adsorption-in-silica.html) and
19+
[Free energy calculation](https://lammpstutorials.github.io/sphinx/build/html/tutorials/level3/free-energy-calculation.html) use some more advanced simulation methods that are commonly used when studying soft matter systems, respectively grand canonical Monte Carlo simulations and a free energy method named umbrella sampling.
20+
21+
<p float="left">
22+
<a href="https://lammpstutorials.github.io/sphinx/build/html/tutorials/level1/lennard-jones-fluid.html">
23+
<img src="https://raw.githubusercontent.com/lammpstutorials/lammpstutorials.github.io/2Aug2023/docs/avatars/level1/lennard-jones-fluid/avatar-Lennard-Jones-LAMMPS.png" width="32%" />
24+
</a>
25+
<a href="https://lammpstutorials.github.io/sphinx/build/html/tutorials/level1/breaking-a-carbon-nanotube.html">
26+
<img src="https://raw.githubusercontent.com/lammpstutorials/lammpstutorials.github.io/2Aug2023/docs/avatars/level1/breaking-a-carbon-nanotube/CNT.png" width="32%" />
27+
</a>
28+
<a href="https://lammpstutorials.github.io/sphinx/build/html/tutorials/level3/water-adsorption-in-silica.html">
29+
<img src="https://raw.githubusercontent.com/lammpstutorials/lammpstutorials.github.io/2Aug2023/docs/avatars/level3/water-adsorption-in-silica/water-adsorption.png" width="32%" />
30+
</a>
31+
</p>
32+
33+
## Access the files
34+
35+
You can access all the files by cloning this repository with its submodules:
36+
37+
```
38+
git clone https://github.com/lammpstutorials/lammpstutorials.github.io.git --recurse-submodule
39+
```
40+
41+
Alternatively, you can download the [inputs](https://github.com/lammpstutorials/lammpstutorials-inputs) only:
42+
43+
```
44+
git clone https://github.com/lammpstutorials/lammpstutorials.github.io.git
45+
```
46+
47+
The Matplotlib Pyplot functions for the figures are shared [here](https://github.com/simongravelle/pyplot-perso).
48+
49+
### Template ###
50+
51+
The template from the first page has been adapted from [HTML5 UP](https://html5up.net/).
52+
The other pages use the [Sphinx](https://www.sphinx-doc.org/) generator with the
53+
[furo style](https://github.com/pradyunsg/furo).
54+

‎README.md‎

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
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+
110
# LAMMPS tutorials
211

312
This is the repository of the [LAMMPS tutorials](https://lammpstutorials.github.io/)
4-
webpage. All the LAMMPS input scripts and data files can be found in a separate repository named [lammpstutorials-inputs](https://github.com/lammpstutorials/lammpstutorials-inputs).
13+
webpage. All the LAMMPS input scripts and data files can be found in a separate
14+
repository named [lammpstutorials-inputs](https://github.com/lammpstutorials/lammpstutorials-inputs).
515

6-
The tutorials are compatible with the 2Aug2023 stable release of LAMMPS.
16+
The tutorials are compatible with the XXXX2024 release of LAMMPS.
717

818
## About LAMMPS tutorials
919

@@ -48,23 +58,34 @@ The Matplotlib Pyplot functions for the figures are shared [here](https://github
4858
### Template ###
4959

5060
The template from the first page has been adapted from [HTML5 UP](https://html5up.net/).
51-
The other pages use the [Sphinx](https://www.sphinx-doc.org/) generator with the [furo style](https://github.com/pradyunsg/furo).
61+
The other pages use the [Sphinx](https://www.sphinx-doc.org/) generator with the
62+
[furo style](https://github.com/pradyunsg/furo).
63+
64+
65+
66+
## Authors
67+
68+
### Project creator
69+
70+
- [Simon Gravelle](https://github.com/simongravelle),
71+
Univ. Grenoble Alpes, CNRS, LIPhy, 38000 Grenoble, France
72+
73+
### Contributors
5274

53-
### About me & Contact ###
75+
- [Jacob R. Gissinger](https://www.stevens.edu/profile/jgissing),
76+
Stevens Institute of Technology, Hoboken, NJ 07030, USA
77+
- [Axel Kohlmeyer](https://sites.google.com/site/akohlmey),
78+
Institute for Computational Molecular Science, Temple University, Philadelphia,
79+
PA 19122, USA
5480

55-
I am a computer physicist in soft matter and fluids at interfaces. You can
56-
find more information on my [personal webpage](https://simongravelle.github.io/).
5781

58-
See the [contact page](https://lammpstutorials.github.io/sphinx/build/html/non-tutorials/contact-me.html).
59-
You can report issues here on Github, or send me an [email](https://simongravelle.github.io/). Your feedback is always appreciated.
6082

61-
### License and Acknowledgments ###
83+
## Acknowledgements
6284

63-
All the LAMMPS inputs/data/parameter files and Python scripts are released under the
64-
GNU general public license v3.0. Feel free to adapt and/or re-publish them.
85+
- Simon Gravelle acknowledges funding from the European Union's Horizon 2020
86+
research and innovation programme under the Marie Skłodowska-Curie grant
87+
agreement No 101065060.
88+
- Axel Kohlmeyer acknowledges financial support by Sandia National Laboratories
89+
under POs 2149742 and 2407526.
6590

66-
This project has received funding from the European
67-
Union's Horizon 2020 research and innovation programme
68-
under the Marie Skłodowska-Curie grant agreement No 101065060.
6991

70-
![Acknowledgments-logos](https://raw.githubusercontent.com/simongravelle/credits/1c44b5ae76a33c5bbbd33a54243365c6abdc24b2/cnrs-uga-liphy-msca.png)

‎dependencies/.github‎

Submodule .github added at 2b1f5b2

‎files.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
./dependencies/.github/COMMENT.md
2+
DESCRIPTION.md
3+
./dependencies/.github/AUTHORS.md
4+
./dependencies/.github/ACKNOWLEDGEMENTS.md

‎generateREADME.sh‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/bash
2+
3+
./dependencies/.github/generateREADME.sh

0 commit comments

Comments
 (0)