corrected spelling and added spell checker action

.codespellrc

@@ -0,0 +1,6 @@
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+skip = .git,.codespellrc,*.pdf,*.pdf_*,*.ai,*.cgns,./CGNS-ReST-site/sidslexer.py
+check-hidden = true
+#ignore-regex =
+ignore-words-list = categorie,otation,Udo,collet,Celcius

.github/workflows/codespell.yml

@@ -0,0 +1,15 @@
+# GitHub Action to automate the identification of common misspellings in text files
+# https://github.com/codespell-project/codespell
+# https://github.com/codespell-project/actions-codespell
+#
+# uses ".codespellrc" for configuration
+#
+name: codespell
+on: [push, pull_request]
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: codespell-project/actions-codespell@master

CGNS-ReST-site/MIGRATION.txt

@@ -5,7 +5,7 @@
 The migration is supposed to be a straightforward translation from a doc
 format to another. This is not exactly the case, the first reason is that some
 parts have be written for paper docs, with duplicated parts. The second is
-the use of the reference links which implies some doc hirarchy reorganisation.
+the use of the reference links which implies some doc hierarchy reorganisation.
 
 The existing pages of the original reference web site are sometimes
 kept unchanged, sometime reorganized. No information is deleted, some

CGNS-ReST-site/source/current/CPEX.rst

@@ -48,7 +48,7 @@ Comments on proposals should be sent to [email protected] and/or written d
 
 
 ..
-  _Comment: Bellow should be listed all CPEX implemented or waiting for review
+  _Comment: Below should be listed all CPEX implemented or waiting for review
 
 
 .. _CPEX0046:

CGNS-ReST-site/source/current/examples.rst

@@ -190,7 +190,7 @@ Business Jet
       - July.29.04
 
 
-  :Description: Multiblock stuctured grids for a business jet, a wing/body, and a wing/body/nacelle/pylon configuration are available from Stanford.
+  :Description: Multiblock structured grids for a business jet, a wing/body, and a wing/body/nacelle/pylon configuration are available from Stanford.
   :Data File: `Stanford CGNS test files <http://aero-comlab.stanford.edu/vdweide/CGNSFiles/>`_ (link to external site)
 
 

CGNS-ReST-site/source/current/news.rst

@@ -58,12 +58,12 @@ the documentation news and fixes and end of this page.
    - Added :ref:`CPEX0042` Storing bounding box of a grid (:issue:`CGNS-149`).
    - Added :ref:`CPEX0043` Family hierarchy as a tree (:issue:`CGNS-180`).
 
-.. topic:: Febuary 17, 2020
+.. topic:: February 17, 2020
 
    - :version:`v4.0.0` of the CGNS Software is released.
    - Added :ref:`CPEX0041` NGON modification proposal (:issue:`CGNS-121`).
 
-.. topic:: Febuary 17, 2020
+.. topic:: February 17, 2020
 
    - :version:`v3.4.1` (patch) of the CGNS Software is released.
    - Removed :ref:`CPEX0041` NGON modification proposal (:issue:`CGNS-121`).
@@ -97,7 +97,7 @@ the documentation news and fixes and end of this page.
      are set then FCFLAGS is ignored.
    - Replaced the hid_t to double (and vice-versa) utilities to_HDF_ID and
      to_ADF_ID from a type cast to a function which uses memcpy for the
-     conversion. This is needed for the upcomming release of HDF5 1.10 where
+     conversion. This is needed for the upcoming release of HDF5 1.10 where
      hid_t was changed from a 32 bit integer to a 64 bit integer.
      Should be transparent to user.
    - Implemented :ref:`CPEX0039` : To enable with CGNS_ENABLE_BASE_SCOPE
@@ -229,7 +229,7 @@ the documentation news and fixes and end of this page.
      a file number (suggestion from Marc Poinet), adds HTMLHelp interface
      to cmake scripts, fixes a compiler complaint about comparison between
      int and enum, and fixes Fortran detection and MPI path problems
-     in the CMake scripts. Compatability with version 2.5
+     in the CMake scripts. Compatibility with version 2.5
      (file type CG_FILE_ADF2) is also fixed for both CG_MODE_WRITE
      and CG_MODE_MODIFY. The CGNStools documentation has been removed
      from the source distribution, and is now accessed from
@@ -249,7 +249,7 @@ the documentation news and fixes and end of this page.
      with MPI. It also implements the Hierarchy of families (CPEX 0033),
      Multiple families (CPEX 0034), and Cubic elements (CPEX 0036).
      Compression (rewriting) of modified CGNS files is no longer automatically
-     done, since this may interfere with parallel I/O. This may be reenabled
+     done, since this may interfere with parallel I/O. This may be re-enabled
      within an application with the cg_set_compress function, or done later
      through the CGNSview GUI or with the cgnscompress program in the tools
      subdirectory. Conversion programs to and from AFLR3, FAST, and TetGen
@@ -352,7 +352,7 @@ the documentation news and fixes and end of this page.
 
 .. topic:: March 11, 2007: Version 2.5.3 released.
 
-   - This version changes the mispelled Celcius to Celsius, fixes handling of
+   - This version changes the misspelled Celcius to Celsius, fixes handling of
      soft links when rewriting the CGNS file, and fixes a number of gcc
      compiler warnings.
 
@@ -406,7 +406,7 @@ the documentation news and fixes and end of this page.
      than a "Windows" type color scheme. Fixes some minor bugs and adds some
      improvement to the cgnscheck program. Allows reading of both HDF5 and
      ADF - based CGNS files (requires the adf2hdf and hdf2adf
-     convertor programs).
+     converter programs).
 
 .. topic:: Spring, 2006:
 
@@ -416,7 +416,7 @@ the documentation news and fixes and end of this page.
      The first is a Panel discussion, tentatively
      titled "CGNS Practical Applications in CFD". This will occur during
      the regular AIAA sessions at the conference.
-     The second is a "CGNS Tutorial Session", currently scheduled for Wednsday,
+     The second is a "CGNS Tutorial Session", currently scheduled for Wednesday,
      7 June 2006 in the evening. This session will be conducted in two parts:
 
      (1) Basic usage of CGNS (including examples for structured
@@ -1357,7 +1357,7 @@ Documentation news
     Corrected an error in the SIDS document, in the Elements_t data structure examples. The examples included DataArray_t data structures defining ParentData for 3-D elements, where it doesn't apply.
 
     ## topic:: In the list of :issue:`CGNS-related` conference papers, added R. Magn
-       - an as an author for AIAA Paper 2005-0334. Apologies for inadvertantly omitting him in the original update.
+       - an as an author for AIAA Paper 2005-0334. Apologies for inadvertently omitting him in the original update.
 
     ## topic:: 19 Jan 2005	
 
@@ -1402,7 +1402,7 @@ Documentation news
 
     ## topic:: 2 Jun 2004	
 
-       - Removed the wording "in the same manner as grid connectivity" in the description of the BC_t node in the SIDS-to-ADF File Mapping Manual, that was inadvertantly left in when the documentation was updated with the release of CGNS Version 2.3.
+       - Removed the wording "in the same manner as grid connectivity" in the description of the BC_t node in the SIDS-to-ADF File Mapping Manual, that was inadvertently left in when the documentation was updated with the release of CGNS Version 2.3.
 
     ## topic:: 18 May 2004	
 

CGNS-ReST-site/source/general/FAQ.rst

@@ -56,7 +56,7 @@ What do I do if CGNS is not capable of handling my particular application?
 
 CGNS has been designed to be very flexible, for handling a wide range of physics applications.
 However, if you find an application that is not covered, you are encouraged to utilize the "``UserDefined``" construct as needed.
-In fact, the ``UserDefined`` node can be used to create an entire tree consisting of multilpe levels of ``UserDefined`` children nodes, so you can create an entire "pattern" for storing particular information.
+In fact, the ``UserDefined`` node can be used to create an entire tree consisting of multiple levels of ``UserDefined`` children nodes, so you can create an entire "pattern" for storing particular information.
 Furthermore, if you feel that a change or addition is needed to the SIDS, or if you feel that a particular "pattern" you have created might be useful to others, please consider submitting a proposal for extension (see :ref:`CPEX guidelines <CPEXguidelines>` and :ref:`Proposed Extensions page <CPEX>`).
 
 

CGNS-ReST-site/source/general/glossary.rst

@@ -15,7 +15,7 @@ Glossary
    API
       Stands for **Application Programming Interface**, it is a set
       of functions, constants, requirements written in a specific
-      programming langage for application developpers.
+      programming language for application developers.
 
    CGNS/MLL
       The **Mid-Level Library** (MLL) is an example implementation of the

CGNS-ReST-site/source/general/overview.rst

@@ -180,7 +180,7 @@ Structure of a CGNS Database In this section, the conceptual structure
 of a CGNS database, and the nodes from which it is built, are
 discussed. This describes the way in which the CGNS software "sees"
 the database, not necessarily the way in which it is
-implementated. The details of the implementation are left to the
+implemented. The details of the implementation are left to the
 underlying database manager.
 
 A CGNS database consists of a collection of elements called
@@ -244,7 +244,7 @@ By definition, the root node of a CGNS database has the Label
 CGNSBase_t. The name of the CGNS database can be specified by the user
 and is stored in the "Name" field of the CGNSBase_t node. Current CGNS
 conventions require that the CGNSBase_t node be located directly below
-a "root node" in the database file indentified by the name "/".
+a "root node" in the database file identified by the name "/".
 
 A database file may contain multiple CGNS databases, and thus multiple
 CGNSBase_t nodes. However, each node labeled CGNSBase_t in a single

CGNS-ReST-site/source/general/what.rst

@@ -100,7 +100,7 @@ freely, subject to the following restrictions:
    not be misrepresented as being the original software.
 3. This notice may not be removed or altered from any source
    distribution.  This license is borrowed from the zlib/libpng License,
-   and supercedes the GNU Lesser General Public License (LGPL) which
+   and supersedes the GNU Lesser General Public License (LGPL) which
    previously governed the use and distribution of the software.
 
 **Reference**

CGNS-ReST-site/source/governance/support.rst

@@ -246,7 +246,7 @@ header
    Fourth level
    ~~~~~~~~~~~~
 
-   Fith level
+   Fifth level
    ++++++++++
 
 The index is generated, you just have to mention an index entry in the text.
@@ -278,7 +278,7 @@ Internal link
 ~~~~~~~~~~~~~
 
 An internal link is composed of its *anchor* (the place in the web site
-where you want to go to) and a *reference* (the words wich triggers
+where you want to go to) and a *reference* (the words which triggers
 the jump to the anchor).
 
 An *anchor* is defined with:

CGNS-ReST-site/source/license.rst

@@ -21,6 +21,6 @@ subject to the following restrictions:
 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
 3. This notice may not be removed or altered from any source distribution.
 
-This license is borrowed from the zlib/libpng License, and supercedes the GNU Lesser General Public License (LGPL) which previously governed the use and distribution of the software.
+This license is borrowed from the zlib/libpng License, and supersedes the GNU Lesser General Public License (LGPL) which previously governed the use and distribution of the software.
 
 .. last line 

CGNS-ReST-site/source/standard/CGIO/CGNS_CGIO_database.rst

@@ -64,18 +64,18 @@ cgio_open_file
      - :code:`int file_mode`
         IN: Mode used for opening the file. The supported modes are. CGIO_MODE_READ, CGIO_MODE_WRITE, and CGIO_MODE_MODIFY.
      - :code:`int* cgio_num`
-        OUT: Indentifier for the open database file.
+        OUT: Identifier for the open database file.
 
   :Returns:         ier - Error status
 
   :Modes:  `r w m`
 
   :Description:
-    Opens a database file of the specified type and mode. If successfull, returns 0, and the database identifier in cgio_num, otherwise returns an error code. The database identifier is used to access the database in subsequent function calls.
+    Opens a database file of the specified type and mode. If successful, returns 0, and the database identifier in cgio_num, otherwise returns an error code. The database identifier is used to access the database in subsequent function calls.
 
     The mode in which the database is opened is given by file_mode, which may take the value CGIO_MODE_READ, CGIO_MODE_WRITE, or CGIO_MODE_MODIFY. New databases should be opened with CGIO_MODE_WRITE, while existing databases are opened with either CGIO_MODE_READ (for read-only access) or CGIO_MODE_MODIFY (for read/write access).
 
-    A specific database type may be specified by file_type, which may be one of CGIO_FILE_NONE, CGIO_FILE_ADF, CGIO_FILE_HDF5, or CGIO_FILE_ADF2. When opening a database in write mode, CGIO_FILE_NONE indicates that the default database type should be used, otherwise the specified database type will be opened. When opening in read or modify mode, CGIO_FILE_NONE indicates that any database type is acceptable, otherwise if the database type does not match that given by file_type an error will be retuned.
+    A specific database type may be specified by file_type, which may be one of CGIO_FILE_NONE, CGIO_FILE_ADF, CGIO_FILE_HDF5, or CGIO_FILE_ADF2. When opening a database in write mode, CGIO_FILE_NONE indicates that the default database type should be used, otherwise the specified database type will be opened. When opening in read or modify mode, CGIO_FILE_NONE indicates that any database type is acceptable, otherwise if the database type does not match that given by file_type an error will be returned.
 
 
 cgio_close_file
@@ -88,7 +88,7 @@ cgio_close_file
 
   :Parameters:
      - :code:`int cgio_num`
-        OUT: Indentifier for the open database file. 
+        OUT: Identifier for the open database file. 
 
   :Returns:         ier - Error status
 
@@ -107,7 +107,7 @@ cgio_get_file_type
 
   :Parameters:
      - :code:`int cgio_num`
-        IN: Indentifier for the open database file.
+        IN: Identifier for the open database file.
      - :code:`int *file_type`
         OUT: Type of database file. acceptable values are :code:`CGIO_FILE_NONE`, :code:`CGIO_FILE_ADF`, :code:`CGIO_FILE_HDF5` and :code:`CGIO_FILE_ADF2`.
 
@@ -116,7 +116,7 @@ cgio_get_file_type
   :Modes:  `r w m`
 
   :Description:
-    Gets the type of the database given by cgio_num. Returns 0 and the type in file_type if successfull, else an error code. 
+    Gets the type of the database given by cgio_num. Returns 0 and the type in file_type if successful, else an error code. 
 
 
 cgio_get_root_id
@@ -129,7 +129,7 @@ cgio_get_root_id
 
   :Parameters:
      - :code:`int cgio_num`
-        IN: Indentifier for the open database file.
+        IN: Identifier for the open database file.
      - :code:`double *rootid`
         OUT: Node identifier for the root node of the database.
 
@@ -138,7 +138,7 @@ cgio_get_root_id
   :Modes:  `r w m`
 
   :Description:
-    Gets the unique node identifier for the root node in the database given by :code:`cgio_num`. Returns 0 and the identifier in :code:`rootid` if successfull, else an error code.
+    Gets the unique node identifier for the root node in the database given by :code:`cgio_num`. Returns 0 and the identifier in :code:`rootid` if successful, else an error code.
 
 
 

CGNS-ReST-site/source/standard/CGIO/CGNS_CGIO_example.rst

@@ -462,7 +462,7 @@ Fortran example
         PRINT *,'   DATA:'
         WRITE(*,200)(ID(I),I=1,6)
   C
-  C     4.) N13 THROUTH L2
+  C     4.) N13 THROUGH L2
   C
         CALL CGIO_GET_NODE_ID_F(ICGIO,RID,'N3/N11/L2',CID,IERR)
         CALL CGIO_GET_LABEL_F(ICGIO,CID,TSTLBL,IERR)

CGNS-ReST-site/source/standard/CGIO/CGNS_CGIO_links.rst

@@ -30,7 +30,7 @@ cgio_is_link
 :Modes:  `r w m`
 
 :Description:
-  Determines if the node indentified by :code:`id` in the database given by :code:`cgio_num` is a link or not. The function returns 0 if successfull, else an error code. If this node is a link, then the total length of the linked-to file and node information is returned in :code:`link_len`. If the node is not a link, :code:`link_len` will be 0. 
+  Determines if the node identified by :code:`id` in the database given by :code:`cgio_num` is a link or not. The function returns 0 if successful, else an error code. If this node is a link, then the total length of the linked-to file and node information is returned in :code:`link_len`. If the node is not a link, :code:`link_len` will be 0. 
 
 
 cgio_link_size
@@ -92,7 +92,7 @@ cgio_create_link
 :Modes:  `- w m`
 
 :Description:
-  Creates a link node as a child of the parent node identified by pid in the database given by cgio_num. The name of the node is given by name, the name of the linked-to file by filename, and the pathname to the linked-to node by name_in_file. If this is an internal link (link to a node in the same database), then filename should be defined as NULL or an empty string. The function returns 0 and the indentifier of the new node in id on success, otherwise an error code is returned.
+  Creates a link node as a child of the parent node identified by pid in the database given by cgio_num. The name of the node is given by name, the name of the linked-to file by filename, and the pathname to the linked-to node by name_in_file. If this is an internal link (link to a node in the same database), then filename should be defined as NULL or an empty string. The function returns 0 and the identifier of the new node in id on success, otherwise an error code is returned.
 
 
 cgio_get_link
@@ -122,7 +122,7 @@ cgio_get_link
 :Modes:  `r w m`
 
 :Description:
-  Gets the link information for the node identified by id in the database given by cgio_num. If successfull, the function returns 0 and the linked-to file name in filename and the node pathname in name_in_file. These strings are '0'-terminated, and thus should be dimensioned at least (file_len + 1) and (name_len + 1), respectively If this is an internal link (link to a node in the same database), then filename will be an empty string. The maximum length for a file name is given by CGIO_MAX_FILE_LENGTH (1024) and for a link pathname by CGIO_MAX_LINK_LENGTH (4096).
+  Gets the link information for the node identified by id in the database given by cgio_num. If successful, the function returns 0 and the linked-to file name in filename and the node pathname in name_in_file. These strings are '0'-terminated, and thus should be dimensioned at least (file_len + 1) and (name_len + 1), respectively If this is an internal link (link to a node in the same database), then filename will be an empty string. The maximum length for a file name is given by CGIO_MAX_FILE_LENGTH (1024) and for a link pathname by CGIO_MAX_LINK_LENGTH (4096).