Fix small typos in documentation

sissaschool · Jun 28, 2022 · 2b2d576 · 2b2d576
1 parent da390b6
commit 2b2d576
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/examples/03_cmdline_example_silica/README.md b/examples/03_cmdline_example_silica/README.md
@@ -1,6 +1,6 @@
 # Example 3: command line (silica)
 
-In this example we perform the same analysis that is performed in the correspondent [example notebook](../02_example_cepstrum_doublecomp_NaCl.ipynb), but using the command-line interface.
+In this example we perform the same analysis that is performed in the correspondent [example notebook](../01_example_cepstrum_singlecomp_silica.ipynb), but using the command-line interface.
 
 Simply run, after installing the package, the following command (see [`run_example.sh`](run_example.sh)):
 

diff --git a/examples/README.md b/examples/README.md
@@ -16,5 +16,5 @@ These examples show how to use the `sportran` package in a Python script, step b
 
 These examples show how to use the command line program `sportran-analysis` (`analysis.py`) to perform cepstral analysis in a straightforward way. This is an expedient tool to analyse a time series using predefined parameters. Results are produced in the form of several text/binary files and pdf plots.
 
-* [03 - Command-line Silica](03_cmdline_example_silica/): analysis of molten NaCl, a two-component system.
+* [03 - Command-line Silica](03_cmdline_example_silica/): analysis of silica glass, a one-component system.
 * [04 - Command-line NaCl](04_cmdline_example_NaCl/): analysis of molten NaCl, a two-component system.
diff --git a/examples/data/Silica/lammps/README.md b/examples/data/Silica/lammps/README.md
@@ -1,9 +1,9 @@
-# Example inputs for LAMMPS simulation of glass silica
+# Example inputs files for LAMMPS simulation of silica glass
 
-In the folder [examples/data/Silica/lammps](https://github.com/sissaschool/sportran/tree/develop/examples/data/Silica/lammps) you can find an example input file to generate some data that you can analyze with sportran.
-To run it you need a working LAMMPS installation and to run the file with, for example
+In the folder [examples/data/Silica/lammps](https://github.com/sissaschool/sportran/tree/develop/examples/data/Silica/lammps) you can find an example LAMMPS input file, to generate heat-flux data that can be analyzed with SporTran.
+To run it you need a working LAMMPS installation and to launch the simulation with, for example:
 
 	mpirun -np 12 lmp_mpi -in silica.in -log silica.out
 
-After this it is possible to extract a simple table file by running the script `convert_lammps_log.sh`.
+After this it is possible to extract the data and export it into a simple *table file* and a *numpy binary data file* by running the script `convert_lammps_log.sh`.
 This input generated the data used in the silica examples.