v0.13.0

edaa-org · Oct 12, 2024 · 1083aee · 1083aee
2 parents 060109a + f078b5f
commit 1083aee
Show file tree

Hide file tree

Showing 98 changed files with 4,503 additions and 924 deletions.
diff --git a/.github/workflows/Pipeline.yml b/.github/workflows/Pipeline.yml
@@ -19,11 +19,6 @@ jobs:
           java-version: '11'
           distribution: 'temurin'
           architecture: x64
-      - name: ❓ Investigate Java environment
-        run: |
-          ls -lAh /usr/share/gradle-*
-          ls -lAh /usr/share/gradle-*/lib/junit-*
-          ls -lAh /usr/share/gradle-*/lib/hamcrest-*
       - name: ✅ Run the Ant 'junit' target
         run: |
           cd examples/Java/JUnit
@@ -259,6 +254,7 @@ jobs:
       - PublishCoverageResults
       - PublishToGitHubPages
 #      - PublishOnPyPI
+      - IntermediateCleanUp
     with:
       package: ${{ fromJson(needs.UnitTestingParams.outputs.artifact_names).package_all }}
       remaining: |

diff --git a/doc/CodeCoverage/index.rst b/doc/CodeCoverage/index.rst
@@ -1,7 +1,17 @@
+.. _CODECOV:
+
 Code Coverage
 #############
 
-.. todo:: Write Code Coverage introduction.
+Code coverage measures used and unused code lines, statements, branches, etc. Depending on the programming language this
+is measured by instrumenting the code/binary and running the program, it's test cases or simulating the code. In
+generate code coverage is a measure of test coverage. Unused code is not (yet) covered by tests.
+
+The code coverage metric in percent is a ratio of used code versus all possibly usable code. A coverage of <100%
+indicates unused code. This can be dead code (unreachable) or untested code (⇒ needs more test cases).
+
+
+.. rubric:: Code Coverage Kinds
 
 * Coverage
 

diff --git a/doc/Dependency.rst b/doc/Dependency.rst
@@ -27,7 +27,7 @@ pyEDAA.Reports Package
 +-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **Package**                                                     | **Version** | **License**                                                                               | **Dependencies**                                                                                                                                       |
 +=================================================================+=============+===========================================================================================+========================================================================================================================================================+
-| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__          | ≥6.6        | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__    | *None*                                                                                                                                                 |
+| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__          | ≥6.7        | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.txt>`__    | *None*                                                                                                                                                 |
 +-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
 | `ruamel.yaml <https://sourceforge.net/projects/ruamel-yaml/>`__ | ≥0.18       | `MIT <https://sourceforge.net/p/ruamel-yaml/code/ci/default/tree/LICENSE>`__              | *Not yet evaluated.*                                                                                                                                   |
 +-----------------------------------------------------------------+-------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -97,15 +97,15 @@ the mandatory dependencies too.
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **Package**                                                                                     | **Version**  | **License**                                                                                              | **Dependencies**                                                                                                                                     |
 +=================================================================================================+==============+==========================================================================================================+======================================================================================================================================================+
-| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__                                          | ≥6.6         | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__                    | *None*                                                                                                                                               |
+| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__                                          | ≥6.7         | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__                    | *None*                                                                                                                                               |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__                                               | ≥7.4         | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__                              | *Not yet evaluated.*                                                                                                                                 |
+| `Sphinx <https://GitHub.com/sphinx-doc/sphinx>`__                                               | ≥8.0         | `BSD 3-Clause <https://GitHub.com/sphinx-doc/sphinx/blob/master/LICENSE>`__                              | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | `sphinx_btd_theme <https://GitHub.com/buildthedocs/sphinx.theme>`__                             | ≥0.5.2       | `MIT <https://GitHub.com/buildthedocs/sphinx.theme/blob/master/LICENSE>`__                               | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | !! `sphinx_fontawesome <https://GitHub.com/fraoustin/sphinx_fontawesome>`__                     | ≥0.0.6       | `GPL 2.0 <https://GitHub.com/fraoustin/sphinx_fontawesome/blob/master/LICENSE>`__                        | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__            | ≥2.3         | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__                      | *Not yet evaluated.*                                                                                                                                 |
+| `sphinx_autodoc_typehints <https://GitHub.com/agronholm/sphinx-autodoc-typehints>`__            | ≥2.5         | `MIT <https://GitHub.com/agronholm/sphinx-autodoc-typehints/blob/master/LICENSE>`__                      | *Not yet evaluated.*                                                                                                                                 |
 +-------------------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 
@@ -133,7 +133,7 @@ install the mandatory dependencies too.
 +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | **Package**                                                                | **Version**  | **License**                                                                                              | **Dependencies**                                                                                                                                     |
 +============================================================================+==============+==========================================================================================================+======================================================================================================================================================+
-| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__                     | ≥6.6         | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__                    | *None*                                                                                                                                               |
+| `pyTooling <https://GitHub.com/pyTooling/pyTooling>`__                     | ≥6.7         | `Apache License, 2.0 <https://GitHub.com/pyTooling/pyTooling/blob/main/LICENSE.md>`__                    | *None*                                                                                                                                               |
 +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
 | `wheel <https://GitHub.com/pypa/wheel>`__                                  | ≥0.44        | `MIT <https://github.com/pypa/wheel/blob/main/LICENSE.txt>`__                                            | *Not yet evaluated.*                                                                                                                                 |
 +----------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+

diff --git a/doc/DocCoverage/index.rst b/doc/DocCoverage/index.rst
@@ -1,4 +1,12 @@
+.. _DOCCOV:
+
 Documentation Coverage
 ######################
 
-.. todo:: Write Documentation Coverage introduction.
+Documentation coverage measures the presence of code documentation. It primarily counts for public language entities
+like publicly visible constants and variables, parameters, types, functions, methods, classes, modules, packages, etc.
+The documentation goal depends on the used coverage collection tool's settings. E.g. usually, private language entities
+are not required to be documented.
+
+The documentation coverage metric in percent is a ratio of documented language entity versus all documentation worthy
+langauge entities. A coverage of <100% indicates undocumented code.
diff --git a/doc/Installation.rst b/doc/Installation.rst
@@ -19,7 +19,7 @@ Installing a Wheel Package from PyPI using PIP
 
 .. tab-set::
 
-   .. tab-item:: Linux/MacOS
+   .. tab-item:: Linux/macOS
       :sync: Linux
 
       .. code-block:: bash
@@ -40,7 +40,7 @@ just all (``all``) dependencies.
 
 .. tab-set::
 
-   .. tab-item:: Linux/MacOS
+   .. tab-item:: Linux/macOS
       :sync: Linux
 
       .. tab-set::
@@ -106,7 +106,7 @@ Updating from PyPI using PIP
 
 .. tab-set::
 
-   .. tab-item:: Linux/MacOS
+   .. tab-item:: Linux/macOS
       :sync: Linux
 
       .. code-block:: bash
@@ -128,7 +128,7 @@ Uninstallation using PIP
 
 .. tab-set::
 
-   .. tab-item:: Linux/MacOS
+   .. tab-item:: Linux/macOS
       :sync: Linux
 
       .. code-block:: bash
@@ -173,7 +173,7 @@ Ensure :ref:`packaging requirements <DEP/packaging>` are installed.
 
 .. tab-set::
 
-   .. tab-item:: Linux/MacOS
+   .. tab-item:: Linux/macOS
       :sync: Linux
 
       .. code-block:: bash

diff --git a/doc/Logging/index.rst b/doc/Logging/index.rst
@@ -0,0 +1,17 @@
+.. _LOGGING:
+
+EDA Tool Logs
+#############
+
+* Simulation logs
+* Synthesis logs
+* Implementation logs
+
+.. rubric:: Goals
+
+* structured machine readable logs with labeling and classifications
+* extract resource utilisation
+* extract timing results
+* extract warnings, critical warnings, errors
+* check for critical behavior (e.g. generated latches, unreachable states, ...)
+* log filtering