diff --git a/README.md b/README.md index ae171c6..c398018 100644 --- a/README.md +++ b/README.md @@ -77,8 +77,16 @@ repositories. On Debian and derivatives, simply run `apt-get install doxygen` under root. +Tutorials +--------- + + * [Infinite system (lattice) tutorial][tutorial-infinite] + * [Finite system tutorial][tutorial-finite] + [SCUFF-EM]: https://homerreid.github.io/scuff-em-documentation/ [GSL]: https://www.gnu.org/software/gsl/ [cmake]: https://cmake.org [TRITON-README]: README.Triton.md +[tutorial-finite]: finite_systems.md +[tutorial-infinite]: lattices.md diff --git a/finite_systems.md b/finite_systems.md new file mode 100644 index 0000000..ac50937 --- /dev/null +++ b/finite_systems.md @@ -0,0 +1,3 @@ +Using QPMS library for simulating finite systems +================================================ + diff --git a/lattices.md b/lattices.md index 0484579..3e05d36 100644 --- a/lattices.md +++ b/lattices.md @@ -69,7 +69,7 @@ direct lattice vectors, `lMax` is the multipole degree cutoff, medium, `npart` number of particles in the unit cell, and `partN` are the positions of these particles inside the unit cell. -Assuming we have the `ew_gen_in` binary in our `${PATH}`, we can +Assuming we have the `ew_gen_kin` binary in our `${PATH}`, we can now run e.g. ``` for omega in $(cat omegalist); do @@ -103,6 +103,7 @@ which would create a directory named `all` containing several Steps 3, 4 ---------- -TODO. For the time being, see e.g. the [TODO SPECIFY] jupyter notebook +TODO. For the time being, see e.g. the `SaraRect/dispersions.ipynb` jupyter notebook +from the `qpms_ipynotebooks` repository for the remaining steps.