Beta release v0.3 RMT, DocEngine and tech specs

* Add an RMT cost report computation feature to the PM module
* Add automatic Markdown table generation from spreadsheets to DocEngine
* Update tech. specs and traceability HTML with new SWD items and data models
* Bug fixes
* Update user manual

Author: CryptographySandbox

CHANGELOG.md

@@ -1,3 +1,31 @@
+# 0.3 (2024-09-15)
+
+## Added
+
+- A resource management tool (RMT) and cost report computation feature to the project management (PM) module
+- A dedicated RMT analysis spreadsheet for obtaining a quick overview: `c5dec/assets/costrep/c5dec-rmt-analysis.xlsx`
+- A new command to the CLI for running the cost report computation feature
+- RMT parameterization file (`rmt-params.xlsx`) to the `c5dec/assets/tshparams` folder
+- An example time sheet input file (`tsh.xlsx`) to the `c5dec/input` folder
+- Automation code to the Quarto-based C5-DEC DocEngine for generating Quarto tables from spreadsheets
+- Unit tests for the time report assistant component of the PM module
+- A unit test suite runner shell script
+- A user manual section to the PM page describing the RMT cost report feature
+- New software design schematics related to the CCT module
+
+## Fixed
+
+- Deployment scripts bug not allowing modification of specs: docs volume mapping
+- Settings module to fix a bug preventing unit test suites to run (relative path)
+- Time report assistant unit tests to compute the correct path
+
+## Modified
+
+- Project resource management tool (RMT) module behavior so it always picks up input files/folders from the `c5dec/input` folder
+- RMT CLI commands and TUI mini apps accordingly to use the new input retrieval mechanism
+- Deployment scripts to improve customization
+- Updated the technical specifications and traceability HTML publication following the inclusion of previously missing SWD items
+
 # 0.2 (2024-07-19)
 
 ## Added

README.md

@@ -28,7 +28,7 @@ To this end, C5-DEC CAD is aimed at assisting both system/software designers/dev
 
 C5-DEC consists of two key elements that complement each other to form a coherent ensemble: a software component (C5-DEC CAD) and a knowledge base (KB) consisting of SSDLC and CPSSA methodologies as well as a [wiki of key CC concepts](./c5dec/assets/database/KnowledgeBase/0_MapofContent.md).
 
-As certain parts of our KB reports rely on ISO standards (ISO/IEC/IEEE 12207, ISO 29119:2022 and ISO 29148:2018), if you wish to access them, please contact us at info@abstractionslab.lu. Simply provide evidence that you are eligible for accessing the standard(s), and upon successful verification, we will share the reports.
+As certain parts of our KB reports rely on ISO standards (ISO/IEC/IEEE 12207,  ISO 29119:2022 and ISO 29148:2018), if you wish to access them, please contact us at info@abstractionslab.lu. Simply provide evidence that you are eligible for accessing the standard(s), and upon successful verification, we will share the reports.
 
 ## Features
 

build-c5dec.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 echo Building C5-DEC CAD image...
-docker build -t c5dec .
+docker build -t c5dec:v0.2.0 .

c5dec.sh

@@ -1,9 +1,28 @@
 #!/bin/bash
 echo Starting C5-DEC CAD...
 
+# Define variables
+USER=root
+CONTAINER_NAME=c5dec-container
+IMAGE_NAME=c5dec:v0.2.0
+
+# Define volume mounts
+C5_VOLUME=$(pwd)/c5dec:/home/$USER/c5dec/c5dec
+DOCS_VOLUME=$(pwd)/docs:/home/$USER/c5dec/docs
+
 if [ "$#" -lt 1 ]
 then
-    docker run --rm -it -v ./c5dec:/home/root/c5dec/c5dec c5dec -h
+    # Run the Docker container with no argument: pass the -h argument to c5dec
+    docker run -it --rm --name $CONTAINER_NAME \
+        -v $C5_VOLUME \
+        -v $DOCS_VOLUME \
+        --network host \
+        $IMAGE_NAME -h 
 else
-    docker run --rm -it -v ./c5dec:/home/root/c5dec/c5dec -p 5432:5432 c5dec "$@"
+    # Run the Docker container with the user-specified arguments
+    docker run -it --rm --name $CONTAINER_NAME \
+        -v $C5_VOLUME \
+        -v $DOCS_VOLUME \
+        -p 5432:5432 \
+        $IMAGE_NAME "$@"
 fi

c5dec/assets/c5dec_params.yml

@@ -7,4 +7,43 @@ etr:
 
 cc:
   # release: "2022R1"
-  release: "3R5"
+  release: "3R5"
+
+# Project resource management field mappings (timesheet, cost report, reference parameter files, etc.)
+pm:
+  tsh: # all timesheet schema mappings
+    sheet-name: "Timesheet"
+    id: "ACR" # a person name acronym
+    day: "Date"
+    month: "MM"
+    year: "YYYY"
+    weekday: "Day"
+    type: "Type"
+    domain: "Domain/Project name"
+    wp: "Cust/WP"
+    task: "Task"
+    loc: "Location"
+    start: "Start"
+    end: "End"
+    hours-spent: "Hours"
+    days-spent: "Days"
+    description: "Description"
+  cost: # all RMT schema mappings
+    daily-rate-col-name: "Daily rate"
+    staff-type-col-name: "StaffType"
+    gross-salary-col-name: "Gross salary"
+    cost-col-name: "Cost"
+    cofunding-rate-col-name: "Cofunding rate"
+    is-fixed-rate-used: "Fixed rate used"
+    social-security: "SocialSec"
+    mg-overhead: "Overhead (MG)"
+    bi-overhead: "Overhead (BI equip/profit)"
+    effective-days: "Effective days"
+    computation-verification-col-name: "ComputeVerif"
+    self-fund-cost-col-name: "Self funding cost"
+    cofund-contribution-col-name: "Cofunding contribution"
+    sheet-tables: # the following item ordering matters: rename but leave order unchanged (to be changed to a dictionary later)
+      - StaffParams
+      - ActivityCostParams
+      - FixedRates
+      - GlobalParams

c5dec/assets/costrep/c5dec-rmt-analysis.xlsx

@@ -4,6 +4,7 @@ project:
   pre-render:
     - scripts/restore_tex_files.py
     - scripts/custom_vars.py
+    # - scripts/tables.py # before uncommenting, create and activate a virtual environment (using venv), activate and install requirements.txt, and set QUARTO_PATH env variable to venv/bin/python
   post-render: 
     - scripts/restore_tex_files.py
 

c5dec/assets/etr/etr_template/_quarto.yml

@@ -0,0 +1,10 @@
+et-xmlfile==1.1.0
+numpy==2.0.1
+openpyxl==3.1.5
+pandas==2.2.2
+python-dateutil==2.9.0.post0
+pytz==2024.1
+PyYAML==6.0.1
+six==1.16.0
+tabulate==0.9.0
+tzdata==2024.1