Ensure STC is installed with Pyccel (pyccel#1787)

Fix pyccel#1654:

- Add https://github.com/Stclib/STC as a git submodule.
- Update file `pyproject.toml` to include essential files from STC.
- Implement an action in `check_for_stc` to verify STC installation.

---------

Co-authored-by: EmilyBourne <[email protected]>

Author: mustapha-belbiad

.docstr.yaml

@@ -1,6 +1,8 @@
 skip_magic: True
 skip_init: True
 fail_under: 0
+exclude:
+  ".*/pyccel/extensions"
 ignore_patterns:
   "syntactic":
     - "_visit_.*"

.github/actions/check_for_stc/action.yml

@@ -0,0 +1,19 @@
+name: 'Ensure STC is installed with Pyccel'
+inputs:
+  not_editable:
+    description: 'not_editable installation'
+    default: 'True'
+runs:
+  using: "composite"
+  steps:
+    - name: check stc installation
+      shell: python
+      run: |
+        import pyccel, os
+        from os.path import exists, join
+        pyccel_loc = pyccel.__path__[0]
+        print(pyccel_loc)
+        print("${{ inputs.not_editable }}")
+        assert(exists(join(pyccel_loc,'extensions/STC/include/stc')))
+        if ${{ inputs.not_editable }}:
+          assert(not exists(join(pyccel_loc,'extensions/STC/docs')))

.github/workflows/anaconda_linux.yml

@@ -56,6 +56,7 @@ jobs:
         with:
           ref: ${{ env.COMMIT }}
           repository: ${{ env.PR_REPO }}
+          submodules: true
       - name: Install dependencies
         uses: ./.github/actions/linux_install
       - uses: conda-incubator/setup-miniconda@v2

.github/workflows/anaconda_windows.yml

@@ -56,6 +56,7 @@ jobs:
         with:
           ref: ${{ env.COMMIT }}
           repository: ${{ env.PR_REPO }}
+          submodules: true
       - uses: conda-incubator/setup-miniconda@v2
         with:
           auto-update-conda: true

.github/workflows/coverage.yml

@@ -44,6 +44,7 @@ jobs:
         with:
           ref: ${{ env.COMMIT }}
           repository: ${{ env.PR_REPO }}
+          submodules: true
       - name: Set up Python ${{ inputs.python_version }}
         uses: actions/setup-python@v4
         with:

.github/workflows/docs.yml

@@ -38,12 +38,14 @@ jobs:
         with:
           ref: ${{ inputs.base }}
           path: base
+          submodules: true
       - uses: actions/checkout@v3
         with:
           path: compare
           ref: ${{ env.COMMIT }}
           repository: ${{ env.PR_REPO }}
           fetch-depth: 0
+          submodules: true
       - name: Set up Python ${{ inputs.python_version }}
         uses: actions/setup-python@v4
         with:

.github/workflows/intel.yml

@@ -58,6 +58,7 @@ jobs:
         with:
           ref: ${{ env.COMMIT }}
           repository: ${{ env.PR_REPO }}
+          submodules: true
       - name: Set up Python ${{ needs.Python_version_picker.outputs.python_version }}
         uses: actions/setup-python@v4
         with:

.github/workflows/linux.yml

@@ -61,6 +61,7 @@ jobs:
         with:
           ref: ${{ env.COMMIT }}
           repository: ${{ env.PR_REPO }}
+          submodules: true
       - name: Set up Python ${{ matrix.python_version }}
         uses: actions/setup-python@v4
         with:

.github/workflows/macosx.yml

@@ -57,6 +57,7 @@ jobs:
         with:
           ref: ${{ env.COMMIT }}
           repository: ${{ env.PR_REPO }}
+          submodules: true
       - name: Set up Python ${{ needs.Python_version_picker.outputs.python_version }}
         uses: actions/setup-python@v4
         with:

.github/workflows/pickle.yml

@@ -66,6 +66,7 @@ jobs:
         with:
           ref: ${{ env.COMMIT }}
           repository: ${{ env.PR_REPO }}
+          submodules: true
       - name: Set up Python ${{ needs.Python_version_picker.outputs.python_version }}
         uses: actions/setup-python@v4
         with:
@@ -87,8 +88,13 @@ jobs:
       - name: Check for existence of pickled files
         id: pickle_check
         uses: ./.github/actions/check_for_pickled
+      - name: Check for STC installation
+        id: stc_check
+        uses: ./.github/actions/check_for_stc
+        with:
+          not_editable: "${{ matrix.editable_string == '-e' && 'False' || 'True'}}"
       - name: "Post completed"
         if: always()
         run: |
-          python ci_tools/basic_json_check_output.py --statuses ${{ steps.pickle.outcome }} ${{ steps.pickle_check.outcome }} --reasons "Installation failed." "Pickled files were not found in installaion."
-          python ci_tools/complete_check_run.py ${{ steps.pickle.outcome }} ${{ steps.pickle_check.outcome }}
+          python ci_tools/basic_json_check_output.py --statuses ${{ steps.pickle.outcome }} ${{ steps.pickle_check.outcome }} ${{ steps.stc_check.outcome }} --reasons "Installation failed." "Pickled files were not found in installaion." "STC was not found during installation."
+          python ci_tools/complete_check_run.py ${{ steps.pickle.outcome }} ${{ steps.pickle_check.outcome }} ${{ steps.stc_check.outcome }}