Merge pull request #246 from JaGeo/attempt_fix_layout_dicts_doc

Update readme and paper.md

README.md

@@ -63,7 +63,7 @@ It is also possible to start this automatic analysis from a Python script. See "
 * **Other command line tools**:
 
     ``lobsterpy create-inputs`` will create standard inputs based on existing POSCAR, POTCAR, and INCAR files. It will allow testing for different basis sets that are available in Lobster. This feature is currently only available for PBE_54 POTCARs, as only the pbeVASPfit2015 basis in LOBSTER that has been fitted to PBE POTCARs includes additional orbitals relevant to solid-state materials. Please
-                        check out our publication https://doi.org/10.1002/cplu.202200123 and LOBSTER program manual for more information
+                        check out our publication [https://doi.org/10.1002/cplu.202200123](https://doi.org/10.1002/cplu.202200123) and LOBSTER program manual for more information
 
 
 * **Further help?**

codecov.yml

@@ -0,0 +1,6 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 97%
+        threshold: 1%

lobsterpy/plotting/layout_dicts.py

@@ -21,6 +21,7 @@
     "paper_bgcolor": "rgba(0,0,0,0)",
     "plot_bgcolor": "rgba(0,0,0,0)",
 }
+
 """
     General layout of Plotly figure.
 
@@ -32,6 +33,7 @@
     :param str paper_bgcolor: background color.
     :param str plot_bgcolor: plot background color.
 """
+
 cohp_axis_style_dict = {
     "titlefont": {"size": 20},
     "tickfont": {"size": 16},
@@ -46,6 +48,7 @@
     "linewidth": 2,
     "linecolor": "black",
 }
+
 """
     COXX axis style.
 
@@ -62,6 +65,7 @@
     :param float linewidth: width of axis line.
     :param str linecolor: color of axis line.
 """
+
 energy_axis_style_dict = {
     "titlefont": {"size": 20},
     "tickfont": {"size": 16},
@@ -76,6 +80,7 @@
     "linewidth": 2,
     "linecolor": "black",
 }
+
 """
     Energy axis style.
 
@@ -92,11 +97,13 @@
     :param float linewidth: width of axis line.
     :param str linecolor: color of axis line.
 """
+
 spin_up_trace_style_dict = {
     "line": {"width": 3},
     "mode": "lines",
     "visible": "legendonly",
 }
+
 """
     Line style for Spin.up traces.
 
@@ -110,18 +117,21 @@
     "mode": "lines",
     "visible": "legendonly",
 }
+
 """
     Line style for Spin.down traces.
 
     :param dict line: Line style dictionary.
     :param str mode: Plotly mode.
     :param str visible: Trace visibility.
 """
+
 legend_style_dict = {
     "bordercolor": "black",
     "borderwidth": 2,
     "traceorder": "normal",
 }
+
 """
     Legend style.
 

paper/paper.md

@@ -85,6 +85,6 @@ providing generous computing time on the GCS Supercomputer
 SuperMUC-NG at Leibniz Supercomputing Centre (www.lrz.de)
 (project pn73da) that enabled rigorous testing of this
 package on a diverse set of compounds. The authors thank Jonas Grandel for reviewing the docstrings and testing package functionalities
-and tutorials. The authors would also like to acknowledge the maintainers of pymatgen and LOBSTER program developers.
+and tutorials. The authors would also like to acknowledge the maintainers of pymatgen and LOBSTER program developers. The authors also greatly appreciate the contributions of the reviewers, who have helped to make this code more user and developer friendly.
 
 # References