Skip to content

Commit 826a4b9

Browse files
committed
added choice
1 parent ee5a5ed commit 826a4b9

File tree

9 files changed

+231
-883
lines changed

9 files changed

+231
-883
lines changed

.github/workflows/gh-pages.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ jobs:
3232
pip install pygments-lammps
3333
pip install sphinx-favicon
3434
pip install sphinxcontrib.bibtex
35+
pip install sphinx-tabs
3536
- name: Build
3637
run: |
3738
cd docs/sphinx/

docs/sphinx/source/_static/custom.css

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,5 +152,12 @@ section {
152152
}
153153

154154

155+
/* Add more specific parent selectors */
156+
body .sphinx-tabs .tab-button {
157+
background-color: red !important;
158+
}
155159

156-
160+
/* If tabs are inside a specific section or container */
161+
section div.sphinx-tabs .tab-button {
162+
background-color: red !important;
163+
}

docs/sphinx/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55

66
extensions = ['sphinx_togglebutton',
77
'sphinx_favicon',
8-
'sphinxcontrib.bibtex']
8+
'sphinxcontrib.bibtex',
9+
'sphinx_tabs.tabs']
910

1011
templates_path = ['_templates']
1112

docs/sphinx/source/journal-article.bib

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ @book{barrat2003basic
55
publisher={Cambridge University Press}
66
}
77

8+
@misc{lammps_docs,
9+
title = {{LAMMPS} Online Documentation for latest stable version},
10+
howpublished = {\url{https://docs.lammps.org/stable}},
11+
note = {Accessed: 2024-07-15}
12+
}
13+
14+
@misc{lammps_run_basics,
15+
title = {{LAMMPS} Run Basics Documentation},
16+
howpublished = {\url{https://docs.lammps.org/Run_basics.html}},
17+
note = {Accessed: 2025-03-22}
18+
}
19+
820
@article{gravelle2025tutorials,
921
author = {Simon Gravelle and Jacob R. Gissinger and Axel Kohlmeyer},
1022
title = {A Set of Tutorials for the LAMMPS Simulation Package},

docs/sphinx/source/shared/access-the-files.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
You can access the input scripts and data files that
2-
are used in these tutorials from a dedicated |Github_repository_input_folder|.
3-
This repository also contains the full solutions to the exercises.
1+
.. admonition:: Cite
2+
:class: non-title-info
3+
4+
You can access the input scripts and data files that
5+
are used in these tutorials from a dedicated |Github_repository_input_folder|.
6+
This repository also contains the full solutions to the exercises.
47

58
.. |Github_repository_input_folder| raw:: html
69

docs/sphinx/source/tutorial1/tutorial.rst

Lines changed: 144 additions & 62 deletions
Large diffs are not rendered by default.

docs/sphinx/source/tutorial2/breaking-a-carbon-nanotube.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Pulling on a carbon nanotube
99

1010
.. include:: introduction.rst
1111
.. include:: ../shared/recommend-tutorial1.rst
12-
.. include:: ../../non-tutorials/needhelp.rst
12+
.. include:: ../shared/cite.rst
1313
.. include:: ../shared/versionLAMMPS.rst
1414
.. include:: tutorial.rst
1515
.. include:: ../shared/access-the-files.rst

docs/sphinx/source/tutorial2/introduction.rst

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,21 @@
1010
:align: right
1111
:class: only-light
1212

13-
The objective of this tutorial is to impose the deformation
14-
of a carbon nanotube (CNT) using LAMMPS.
13+
In this tutorial, the system of interest is a small, single-walled carbon
14+
nanotube (CNT) in an empty box. The CNT is strained
15+
by imposing a constant velocity on the edge atoms. To illustrate the
16+
difference between conventional and reactive force fields, this tutorial
17+
is divided into two parts: in the first part, a conventional molecular
18+
force field (called OPLS-AA :cite:`jorgensenDevelopmentTestingOPLS1996`)
19+
is used and the bonds between the atoms of the CNT are unbreakable. In
20+
the second part, a reactive force field (called AIREBO :cite:`stuart2000reactive`)
21+
is used, which allows chemical bonds to break under large strain.
1522

16-
In this tutorial, a small carbon nanotube (CNT) is simulated
17-
within an empty box using LAMMPS. An external
18-
force is imposed on the CNT, and its deformation is measured over time.
19-
20-
To illustrate the difference between classical and reactive force fields,
21-
this tutorial is divided into two parts. Within the first part, a classical
22-
force field is used and the bonds between the atoms of the CNT are
23-
unbreakable. Within the second part, a reactive force field
24-
(named AIREBO :cite:`stuart2000reactive`) is used, allowing for the breaking
25-
of chemical bonds when the CNT undergoes strong deformation.
23+
To set up this tutorial, select *Start Tutorial 2* from the *Tutorials*
24+
menu of LAMMPS-GUI and follow the instructions. This will select a folder,
25+
create one if necessary, and place several files into it. The initial
26+
input file, set up for a single-point energy calculation, will also be
27+
loaded into the editor under the name *unbreakable.lmp*. Additional files
28+
are a data file containing the CNT topology and geometry, named
29+
*unbreakable.data*, a parameters file named *unbreakable.inc*, as well as
30+
the scripts required for the second part of the tutorial.

0 commit comments

Comments
 (0)