Merge pull request #35 from Anselmoo/fixed-minor

Fixed minor issues

.github/workflows/python-ci.yml

@@ -10,9 +10,9 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
-    - uses: pre-commit/action@v2.0.3
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/action@v2.0.3
   build:
     name: Python ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
     needs: pre-commit
@@ -43,7 +43,7 @@ jobs:
       - name: Install SpectraFit
         run: |
           poetry install
-          poetry run pytest --diff-symbols --cov=./spectrafit -vv --cov-report=xml
+          poetry run pytest --diff-symbols --cov=./spectrafit -vv --cov-report=xml --plots
       - name: Codecov
         uses: codecov/codecov-action@v2
         with:
@@ -78,7 +78,7 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Build the Docker image
-      run: |
-        docker build . --file Dockerfile --tag spectrafit:$(date +%s)
+      - uses: actions/checkout@v2
+      - name: Build the Docker image
+        run: |
+          docker build . --file Dockerfile --tag spectrafit:$(date +%s)

Examples/example_1_summary.json

@@ -11,7 +11,7 @@
         0,
         1
     ],
-    "seperator": "\t",
+    "separator": "\t",
     "decimal": ".",
     "header": null,
     "noplot": false,

Examples/example_2.json

@@ -8,7 +8,7 @@
     "infile": "data.txt",
     "outfile": "example_2",
     "oversampling": false,
-    "seperator": "\t",
+    "separator": "\t",
     "shift": 0,
     "smooth": 0,
     "verbose": false,

Examples/example_2_summary.json

@@ -11,7 +11,7 @@
         0,
         1
     ],
-    "seperator": "\t",
+    "separator": "\t",
     "decimal": ".",
     "header": null,
     "noplot": false,

Examples/example_3.json

@@ -8,7 +8,7 @@
     "infile": "data.csv",
     "outfile": "example_3",
     "oversampling": false,
-    "seperator": ",",
+    "separator": ",",
     "shift": 0,
     "smooth": 0,
     "verbose": false,

Examples/example_3_summary.json

@@ -11,7 +11,7 @@
         "Energy",
         "Noisy"
     ],
-    "seperator": ",",
+    "separator": ",",
     "decimal": ".",
     "header": 0,
     "noplot": false,

README.md

@@ -29,6 +29,10 @@ via pip:
 
 ```shell
 pip install spectrafit
+
+# Upgrade
+
+pip install spectrafit --upgrade
 ```
 
 ## Usage:
@@ -87,10 +91,10 @@ optional arguments:
                         Constant applied energy shift; default to 0.0.
   -c COLUMN COLUMN, --column COLUMN COLUMN
                         Selected columns for the energy- and intensity-values; default to 0 for energy (x-axis) and 1 for intensity (y-axis).
-  -sep {        ,,,;,:,|, ,s+}, --seperator {   ,,,;,:,|, ,s+}
-                        Redefine the type of seperator; default to ' '.
+  -sep {        ,,,;,:,|, ,s+}, --separator {   ,,,;,:,|, ,s+}
+                        Redefine the type of separator; default to ' '.
   -dec {.,,}, --decimal {.,,}
-                        Type of decimal seperator; default to '.'.
+                        Type of decimal separator; default to '.'.
   -hd HEADER, --header HEADER
                         Selected the header for the dataframe; default to None.
   -np, --noplot         No plotting the spectra and the fit of `spectrafit`.

docs/examples/example3.md

@@ -57,7 +57,7 @@ also printed in the terminal output:
         "infile": "data.txt",
         "outfile": "example_2_results",
         "oversampling": false,
-        "seperator": "\t",
+        "separator": "\t",
         "shift": 0,
         "smooth": 0,
         "verbose": false,

docs/examples/example4.md

@@ -635,7 +635,7 @@ following changes between previous
     "infile": "data.txt",
     "outfile": "example_2",
     "oversampling": false,
-    "seperator": "\t",
+    "separator": "\t",
     "shift": 0,
     "smooth": 0,
     "verbose": false,
@@ -656,7 +656,7 @@ and actually
     "infile": "spectrafit/test/test_data.csv",
     "outfile": "fit_results",
     "oversampling": true,
-    "seperator": ",",
+    "separator": ",",
     "shift": 0.2,
     "smooth": 4,
     "verbose": true,
@@ -669,7 +669,7 @@ have to be performed.
 
 1. **Column**: `int` (index of the column) --> `str` (name of the column)
 2. **header**: `null` (no header at all) --> `0` (header start at row-number 0)
-3. **seperator**: `\t` (columns are separated by tab character) --> `,` (columns
+3. **separator**: `\t` (columns are separated by tab character) --> `,` (columns
    are separated by comma character)
 
 ```shell

docs/interface/features.md

@@ -199,7 +199,7 @@ different types of output files will be generated
                  0,
                  1
              ],
-             "seperator": "\t",
+             "separator": "\t",
              "decimal": ".",
              "header": null,
              "noplot": true,
@@ -321,7 +321,7 @@ different types of output files will be generated
       "smooth": 0,
       "shift": 0,
       "column": [0, 1],
-      "seperator": "\t",
+      "separator": "\t",
       "decimal": ".",
       "header": null,
       "noplot": true,

docs/interface/usage.md

@@ -129,7 +129,7 @@ In case of advanced usage of `SpectraFit`, the following steps are necessary:
     "infile": "spectrafit/test/rixs_fecl4.txt",
     "outfile": "fit_results",
     "oversampling": false,
-    "seperator": "\t",
+    "separator": "\t",
     "shift": 0,
     "smooth": 0,
     "verbose": false,
@@ -231,7 +231,7 @@ types.
         "outfile": "fit_results",
         "oversampling": false,
         "noplot": false,
-        "seperator": "\t",
+        "separator": "\t",
         "shift": 0,
         "smooth": 0,
         "verbose": false,

mkdocs.yml

@@ -14,14 +14,13 @@ copyright: Copyright © 2021 - Anselm Hahn
 # Configuration
 theme:
   name: material
-  features:
-    - navigation.expand
   static_templates:
     - 404.html
   include_search_page: true
   search_index_only: true
   language: en
   features:
+    - navigation.expand
     - content.code.annotate
     - content.tabs.link
     - header.autohide