Pre-release housekeeping (#174)

Minor changes tidying things up in anticipation of the beta release, including: - removing the `examples/` (they were outdated) - removing the `SSSP` pseudo library (not especially useful since many of these are not norm-conserving, and it takes up 600MB) - bugfixes to the `ParallelCommand` class
epfl-theos · Aug 19, 2022 · 34dc922 · 34dc922
1 parent 38ebdc4
commit 34dc922
Show file tree

Hide file tree

Showing 367 changed files with 58 additions and 5,390,326 deletions.
diff --git a/ase b/ase
diff --git a/docs/about.rst b/docs/about.rst
@@ -1,11 +1,11 @@
 About
 =====
 
-``koopmans`` is a package for performing Koopmans spectral functional calculations with ``Quantum ESPRESSO``.
+``koopmans`` is a package for performing Koopmans spectral functional calculations with ``Quantum ESPRESSO``, developed by researchers in the `THEOS <http://theossrv1.epfl.ch/>`_ research group at `EPFL <https://www.epfl.ch/en/>`_.
 
 The package includes...
 
+* the official version of ``Quantum ESPRESSO``, which contains Koopmans functionals implemented with a :math:`k`-point framework  
 * a modified version of ``Quantum ESPRESSO v4.1`` with Koopmans functionals implemented within the ``cp.x`` code (:math:`\Gamma`-only)  
-* a modified version of the latest version of ``Quantum ESPRESSO``, with Koopmans functionals implemented with a :math:`k`-point framework  
 * ``koopmans``, a python package and executable that makes running Koopmans spectral calculations with the above codes easy!  
 
diff --git a/docs/contact.rst b/docs/contact.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,8 +18,6 @@ Contents
    running
    modules
    tutorials
-   links
+   support
    references
-   license
-   contact
-
+   links
diff --git a/docs/license.rst b/docs/license.rst
diff --git a/docs/links.rst b/docs/links.rst
@@ -1,6 +1,11 @@
 Useful links
 ############
 
+koopmans
+********
+* `Github <https://github.com/epfl-theos/koopmans/>`_
+* `Mailing list <https://groups.google.com/g/koopmans-users>`_
+
 Quantum Espresso
 ****************
 * `Website <https://www.quantum-espresso.org>`_

diff --git a/docs/support.rst b/docs/support.rst
@@ -0,0 +1,6 @@
+Support and feedback
+********************
+
+If you have any questions about running ``koopmans``, post it to our `mailing list <https://groups.google.com/g/koopmans-users>`_
+
+If you have a bug to report, please `open an issue on GitHub <https://github.com/epfl-theos/koopmans/issues>`_
diff --git a/examples/.gitignore b/examples/.gitignore
diff --git a/examples/bulk_silicon/dfpt/si.json b/examples/bulk_silicon/dfpt/si.json
diff --git a/examples/bulk_silicon/dfpt_with_dscf_screening/si.json b/examples/bulk_silicon/dfpt_with_dscf_screening/si.json
diff --git a/examples/bulk_silicon/dscf/si.json b/examples/bulk_silicon/dscf/si.json
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,8 +18,6 @@ Contents @@
        running
        modules
        tutorials
-       links
+       support
        references
-       license
-       contact
+       links