Add a codespell lint job

.github/workflows/lint.yml

@@ -13,6 +13,21 @@ on:
     - 'GSOC**'
 
 jobs:
+  codespell:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Lint with codespell
+      run: |
+        python -m pip install --upgrade pip
+        pip install codespell
+        git ls-files -z | xargs -0 codespell --check-filenames
+
   flake8:
     runs-on: ubuntu-latest
     timeout-minutes: 10

CHANGES.rst

@@ -80,7 +80,7 @@ https://github.com/Open-MSS/MSS/milestone/99?closed=1
 Version 8.3.0
 ~~~~~~~~~~~~~
 
-Bug fix release and minor enhacements:
+Bug fix release and minor enhancements:
 We improved the KML docking widget feature
 
 All changes:
@@ -89,7 +89,7 @@ https://github.com/Open-MSS/MSS/milestone/98?closed=1
 Version 8.2.0
 ~~~~~~~~~~~~~
 
-Bug fix release and minor enhacements:
+Bug fix release and minor enhancements:
 
 HINT:
 ~~~~~
@@ -148,7 +148,7 @@ Jatin Jain did UI and server improvements in his GSoC project.
 Users can now, compare and plot multiple flightpaths on topview.
 This feature can be used for flightpathes or MSColab operations.
 A fligthpath style width can be changed.
-Timestamps are dislayed below each message in MSColab.
+Timestamps are displayed below each message in MSColab.
 Mscolab Operations in use for more than 30 days, move to an inactive list.
 The initial idea for multiple flightpaths on topview stems from bkirbus.
 GSoC mentors were Reimar Bauer, Jörn Ungermann, Sonja Gisinger
@@ -311,7 +311,7 @@ Version 6.1.0
 ~~~~~~~~~~~~~
 
 This release includes some small improvements of the usablity.
-A few bug fixes, a new plugin for NAVAID waypoints is decribed and
+A few bug fixes, a new plugin for NAVAID waypoints is described and
 mscolab gots few improvements for user creation.
 Wind speed plots can now be created for altitudes > 25km.
 
@@ -474,7 +474,7 @@ HINT:
 ~~~~~
 
 For using the 1-D samples along the flight path you have to add a configuration to your
-mss_wms_settings.py. Similiar as to the other layers add:
+mss_wms_settings.py. Similar as to the other layers add:
 
 .. code-block:: python
 
@@ -634,7 +634,7 @@ Bug Fixes:
   - Error in handling project permission update in mscolab, #539
   - mscolab: Selected Project highlight removed if new project is added, #533
   - GUI tests fail in OSX, #531
-  - developer hint seperate data from source, #529
+  - developer hint separate data from source, #529
   - PyVirtualDisplay Package not found for Windows OS, #527
   - sync our meta.yaml with the one on conda-forge, #526
   - improve "Building a development environment", #524
@@ -657,7 +657,7 @@ Bug Fixes:
   - make rtfd use of Non-ASCII characters, #492
   - mscolab server command crashes, #491
   - MSS doesn't close when "quit"ing while being connected to MSCO server, #490
-  - "Checkout" of older revisions has no effect without double-clicking the revison, #485
+  - "Checkout" of older revisions has no effect without double-clicking the revision, #485
   - Adding unknown user to project throws exception, #483
   - mcso windows cannot be closed by ctrl+w, #473
 
@@ -698,7 +698,7 @@ HINT
 ~~~~
   - We deprecated and disabled the unmaintained feature trajectory and time series view. This will become removed in
     the next major release, #476
-  - We added a new powerfull feature for collaborative editing of flight pathes.
+  - We added a new powerful feature for collaborative editing of flight paths.
     This is a new server and also a new client gui window.
     In a future version the client gui will replace the standard gui.
 
@@ -771,8 +771,8 @@ New Features:
   - Avoid "catch-all" exception handlers, #42
 
 Bug Fixes:
-  - Top View Map Appeareance options not defined with web map services, #401
-  - Image dissappears after insert/delete operation in sideview mode, #399
+  - Top View Map Appearance options not defined with web map services, #401
+  - Image disappears after insert/delete operation in sideview mode, #399
   - sideview options dialog suffix always hPa, #394
   - Msui crashes on selecting Northern Hemisphere (stereo) from drop down menu under Top View section, #388
   - qt widget property issue, #387
@@ -781,7 +781,7 @@ Bug Fixes:
 
 Other Changes:
   - clean up comments, #406
-  - remove superflous pass statements, #405
+  - remove superfluous pass statements, #405
   - Change comments for function "flightlevel2pressure_a", #384
   - Documentation about Reporting Issues, #112
 
@@ -822,7 +822,7 @@ Bug Fixes:
   - Support http://msgcpp-ogc-realtime.knmi.nl/msgrt.cgi WMS Server, #352
   - Support http://geoservices.knmi.nl/cgi-bin/HARM_N25.cgi WMS server, #351
   - Support NASA WMS Server "https://neo.sci.gsfc.nasa.gov/wms/wms", #348
-  - wms server: return only on the getcapability request a capabilty document, #346
+  - wms server: return only on the getcapability request a capability document, #346
   - demodata pressure levels uses inconsistent units, #341
   - waypoint labels (in sideview) not readable, #317
 
@@ -865,7 +865,7 @@ Version 1.7.0
 -------------
 
 New Features:
- - Decrease unit depency of plotting styles, #328
+ - Decrease unit dependency of plotting styles, #328
  - Support basemap 1.1.0, #315, #329
  - zorder of several plot elements in topview is wrong, #314
  - pyfilesystem2 implemented, #313
@@ -933,7 +933,7 @@ Version 1.6.0
 
 New Features:
  - disable traceback for server, #156
- - hybrid sigma coordinate whould work with float values, #203
+ - hybrid sigma coordinate would work with float values, #203
  - WMS data access classes difficult to set up, #210
  - add mss to docker platform, 211
  - loading a flighttrackfile does not set filename, #214
@@ -948,7 +948,7 @@ New Features:
  - Try preloading WMS servers on startup, #250
  - traceback should show version info, #256
  - add version info to output files, #259
- - completly remove vt_cache, #260
+ - completely remove vt_cache, #260
  - update layer list on get_capabilities, #268
 
 Bug Fixes:
@@ -1033,7 +1033,7 @@ Version 1.5.1
 -------------
 
 Bug Fixes:
- - clicks on same position crashs waypoint insert for cyl projection, #197
+ - clicks on same position crashes waypoint insert for cyl projection, #197
  - existing picklefiles of py2 crash on py3 version (vice versa), #198
 
 
@@ -1051,12 +1051,12 @@ New Features:
  - refactored url strings, #150
  - performance data used for time information on vertical plots, #151
  - use a singleton for WMS capability storage, #168
- - ui files, _test folders excluded from conda build pacakages, #169
+ - ui files, _test folders excluded from conda build packages, #169
  - implemented virtualdisplay for linux, #172
  - cache for basemap coastline and country shape data added, #173
- - consistant naming of "as" imports, #175
+ - consistent naming of "as" imports, #175
  - loopview enable/disabled, based on given URL, #183
- - configurable external proxy to cache on low bandwidth transfered images, #188
+ - configurable external proxy to cache on low bandwidth transferred images, #188
 
 
 Bug Fixes:
@@ -1067,7 +1067,7 @@ Bug Fixes:
 
 
 Other Changes:
- - line seperator of source files unified to LF, #92
+ - line separator of source files unified to LF, #92
  - refactored whole codebase for compatibility with python3, #176
  - version number of recent conda package added to documentation, #185
  - split mss_settings.json.sample into snippet parts, and further documentation #194
@@ -1131,7 +1131,7 @@ Version 1.3.3
 
 Bug Fixes:
  - Inserting Waypoint outside of map in TopView crashes MSS, #149
- - Some of the additional tools don't close completly, #139
+ - Some of the additional tools don't close completely, #139
 
 
 Version 1.3.2
@@ -1279,7 +1279,7 @@ Bug Fixes:
 
 
 Other Changes:
- - Namespace refactored, all modules dependend to mslib #24
+ - Namespace refactored, all modules dependent to mslib #24
  - Sphinx documentation introduced, #25, #26
  - Documentation on http://mss.rtfd.io
  - Installation recipes based on conda

codespell-ignored-lines.txt

@@ -0,0 +1,2 @@
+  ssl_ciphers         HIGH:!aNULL:!MD5;
+ - moved of mslib.thirdparty.owslib to mslib.owslib and hardcoded all imports in owslib to mslib.owslib, #1

conftest.py

@@ -85,7 +85,7 @@ def generate_initial_config():
     if not constants.ROOT_FS.exists("msui/testdata"):
         constants.ROOT_FS.makedirs("msui/testdata")
 
-    # make a copy for mscolab test, so that we read different pathes during parallel tests.
+    # make a copy for mscolab test, so that we read different paths during parallel tests.
     sample_path = os.path.join(os.path.dirname(__file__), "tests", "data")
     shutil.copy(os.path.join(sample_path, "example.ftml"), constants.ROOT_DIR)
 

docs/about.rst

@@ -3,8 +3,8 @@ About
 
 The Mission Support System (MSS) is a software that is written by scientists in the field of atmospheric science.
 The purpose is to have a tool that simplifies the process for planning a scientific flight in which
-parameters of the atmosphere are measured.  The research aircrafts typically carry a comprehensive scientific payload
-comprised of data aquisition instruments by different companies and research institutions.
+parameters of the atmosphere are measured.  The research aircraft typically carry a comprehensive scientific payload
+comprised of data acquisition instruments by different companies and research institutions.
 The measurement of relevant parameters, for example the chemical composition of trace gases,
 temperature or aerosol particle characteristics, are needed to improve the scientific understanding of the processes
 in the atmosphere. This is of significant importance for the understanding for example of climate change or the

docs/development.rst

@@ -7,8 +7,8 @@ This chapter will get you started with MSS development.
 
 MSS is written in Python.
 
-Once a stable release is published we do only bug fixes in stable and release regulary
-new minor versions. If a fix needs a API change or it is likly more a new feature you have
+Once a stable release is published we do only bug fixes in stable and release regularly
+new minor versions. If a fix needs a API change or it is likely more a new feature you have
 to make a pull request to the develop branch. Documentation of changes is done by using our
 `issue tracker <https://github.com/Open-MSS/MSS/issues>`_.
 
@@ -147,7 +147,7 @@ Using predefined docker images instead of installing all requirements
 
 You can easily use our testing docker images which have all libraries pre installed. These are based on miniforge.
 We provide two images. In openmss/testing-stable we have mss-stable-env and in openmss/testing-develop we have mss-develop-env defined.
-In the further course of the documentation we speak of the environment mssdev, this corresponds to one of these evironments.
+In the further course of the documentation we speak of the environment mssdev, this corresponds to one of these environments.
 
 You can either mount your MSS workdir in the container or use the environment from the container as environment on your machine.
 
@@ -282,7 +282,7 @@ Building the docs with Sphinx
 The documentation (in reStructuredText format, .rst) is in docs/.
 
 Usually building the docs also includes creating the images and pages for the gallery feature.
-This can be ommitted by setting an environment variable ::
+This can be omitted by setting an environment variable ::
 
    export GALLERY=False
 
@@ -428,7 +428,7 @@ After filling the template completely click on Pull request
 Merging stable into develop
 ---------------------------
 
-Bug fixes we have done in stable we need to merge regulary into develop too::
+Bug fixes we have done in stable we need to merge regularly into develop too::
 
    git checkout stable
    git pull git@github.com:Open-MSS/MSS.git stable

docs/installation.rst

@@ -6,7 +6,7 @@ The Mission Support System (MSS) including a Web Map Service, a Collaboration Se
 
 This channel conda-forge has builds for osx-64, linux-64, win-64
 
-The conda-forge `github organization <https://conda-forge.github.io/>`_ uses various automated continuos integration
+The conda-forge `github organization <https://conda-forge.github.io/>`_ uses various automated continuous integration
 build processes.
 
 We provide an automatic installation and a manual installation.
@@ -147,7 +147,7 @@ you could try the `mamba update mss` as described.
 
 
 .. Important::
-  mamba is under development. All dependencies of MSS and MSS itselfs are under development.
+  mamba is under development. All dependencies of MSS and MSS itself are under development.
   Sometimes this update feature of mamba can't resolve from existing to new dependencies.
 
 search for MSS what you can get ::
@@ -164,7 +164,7 @@ compare what you have installed ::
      mss                            7.0.2     py310hff52083_0    conda-forge
 
 
-We have reports that often an update suceeds by using the install option and the new version number,
+We have reports that often an update succeeds by using the install option and the new version number,
 in this example $mss_version and python as second option ::
 
    (mssenv) $ mamba install mss=$mss_version python
@@ -175,7 +175,7 @@ The alternative is to use a new environment and install mss.
 
 
 
-For further details of configurating mss :ref:`msui-configuration`
+For further details of configuring mss :ref:`msui-configuration`
 
 
 Docker Instance

docs/mscolab.rst

@@ -54,7 +54,7 @@ Make a text file with the following format to import many users to the mscolab d
 
   $ mscolab db --users_by_file /path/to/file
 
-After executed you get informations to exchange with users.
+After executed you get information to exchange with users.
 
  .. code-block:: text
 
@@ -69,7 +69,7 @@ Further options can be listed by `mscolab db -h`
 
 User Groups for Operations
 ..........................
-When you want to use same set of users for different operations using same catagory
+When you want to use same set of users for different operations using same category
 you can do this by setting up users in a special operation.
 
 On a given category for an operation ending with GROUP_POSTFIX
@@ -139,10 +139,10 @@ If you want to use nginx to proxy this gunicorn server have a look on the exampl
 Backup Data Base
 ................
 
-For backups you can dump by `pg_dump -d mscolab -f outpu.sql` the sqlite database
+For backups you can dump by `pg_dump -d mscolab -f output.sql` the sqlite database
 and restore it by `psql -v ON_ERROR_STOP=1 < new_db.sql`
 
-On a PostgreSQL db you can regulary do backups by creating a dump
+On a PostgreSQL db you can regularly do backups by creating a dump
 by `pg_dump <https://www.postgresql.org/docs/current/app-pgdump.html>`_ using a cron job ::
 
     #!/bin/bash

docs/mswms.rst

@@ -495,7 +495,7 @@ package apache2-dev on your server.
 
 At current state we have to use pip to install mod_wsgi into the INSTANCE environment::
 
-  # Instal `mod_wsgi`
+  # Install `mod_wsgi`
   $ pip install mod_wsgi
 
   # Find the full path to installed `mod_wsgi`
@@ -519,7 +519,7 @@ Enable the new module by a2enmod and reload the apache2 server
 Configuration of apache mod_wsgi.conf
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-One posibility to setup the PYTHONPATH environment variable is by adding it to your mod_wsgi.conf. Alternativly you
+One possibility to setup the PYTHONPATH environment variable is by adding it to your mod_wsgi.conf. Alternatively you
 could add it also to wms.wsgi.
 
   WSGIPythonPath /home/mss/INSTANCE/config:/home/mss/miniforge/envs/instance/lib/python3.X/site-packages
@@ -616,7 +616,7 @@ Enable it with a2ensite mss.yourserver.de.conf
 Many Instances
 ..............
 
-If you want to setup many instances we suggest to use a similiar proxy based configuration
+If you want to setup many instances we suggest to use a similar proxy based configuration
 
  .. literalinclude:: samples/sites-available/mss_proxy.conf
 

docs/samples/config/mscolab/setup_saml2_backend.py.sample

@@ -32,7 +32,7 @@ class setup_saml2_backend:
                 yaml_data["config"]["localhost_test_idp"]["key_file"] = \
                     f'{mscolab_settings.MSCOLAB_SSO_DIR}/key_mscolab.key'  # set path to your mscolab key file
                 yaml_data["config"]["localhost_test_idp"]["cert_file"] = \
-                    f'{mscolab_settings.MSCOLAB_SSO_DIR}/crt_mscolab.crt'  # set path to your mscolab certiticate file
+                    f'{mscolab_settings.MSCOLAB_SSO_DIR}/crt_mscolab.crt'  # set path to your mscolab certificate file
                 yaml_data["config"]["localhost_test_idp"]["metadata"]["local"][0] = \
                     f'{mscolab_settings.MSCOLAB_SSO_DIR}/idp.xml'  # set path to your idp metadata xml file
 
@@ -41,7 +41,7 @@ class setup_saml2_backend:
                     if not os.path.exists(yaml_data["config"]["localhost_test_idp"]["metadata"]["local"][0]):
                         yaml_data["config"]["localhost_test_idp"]["metadata"]["local"] = []
                         warnings.warn("idp.xml file does not exists !\
-                                        Ignore this warning when you initializeing metadata.")
+                                        Ignore this warning when you initialize metadata.")
 
                     localhost_test_idp = SPConfig().load(yaml_data["config"]["localhost_test_idp"])
                     sp_localhost_test_idp = Saml2Client(localhost_test_idp)

docs/samples/config/msui/performance_simple.json.sample

@@ -11,5 +11,5 @@
     "_comment3": "empty_weight: aircraft weight without fuel (lbs)",
     "_comment4": "climb/descent: weight(lbs), altitude(ft), duration(min), distance(nm), fuel(lbs)",
     "_comment5": "cruise: weight(lbs), altitude(ft), total air speed(nm/h), fuel flow(lbs/h)",
-    "_comment6": "ceiling: polynomial coeficients for relating weight (lbs) with peak flightlevel (hft). Leftmost coefficient is the intercept."
+    "_comment6": "ceiling: polynomial coefficients for relating weight (lbs) with peak flightlevel (hft). Leftmost coefficient is the intercept."
 }