Skip to content

Commit

Permalink
tweak readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
@jasonbelt
jasonbelt committed Apr 5, 2024
1 parent 5cfbb5f commit 37edef3
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 54 deletions.
26 changes: 13 additions & 13 deletions isolette/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -219,9 +219,9 @@ likely would be excluded in a release build
<!--end____isolette_gumbox-unit-testing-setup_configurations-description-->
#### <!--start__isolette_gumbox-unit-testing-setup_configurations_ma_configurations-title-->MA<!--end____isolette_gumbox-unit-testing-setup_configurations_ma_configurations-title-->
<!--start__isolette_gumbox-unit-testing-setup_configurations_ma_configurations-description-->
- GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Monitor/Manage_Alarm_impl_thermostat_monitor_temperature_manage_alarm_GumboX_UnitTests.scala)
- Component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Alarm_impl_thermostat_monitor_temperature_manage_alarm_DSC_UnitTests/report.html)<br>
*(Custom configurations were used for this component. Click [here](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/default_configs/isolette/Manage_Alarm_impl_thermostat_monitor_temperature_manage_alarm_DSC_UnitTests/report.html) for the coverage report obtained when only the default configurations are used)*
- Auto-generated GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Monitor/Manage_Alarm_impl_thermostat_monitor_temperature_manage_alarm_GumboX_UnitTests.scala), that was subsequently modified to provide custom configurations
- Auto-generated component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Alarm_impl_thermostat_monitor_temperature_manage_alarm_DSC_UnitTests/report.html). Custom configurations were used for this component. Click [here](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/default_configs/isolette/Manage_Alarm_impl_thermostat_monitor_temperature_manage_alarm_DSC_UnitTests/report.html)
for the coverage report obtained when only the default configurations are used

- Configurations for the Initialize Entrypoint
<table>
Expand All @@ -237,8 +237,8 @@ likely would be excluded in a release build

#### <!--start__isolette_gumbox-unit-testing-setup_configurations_mmi_configurations-title-->MMI<!--end____isolette_gumbox-unit-testing-setup_configurations_mmi_configurations-title-->
<!--start__isolette_gumbox-unit-testing-setup_configurations_mmi_configurations-description-->
- GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Monitor/Manage_Monitor_Interface_impl_thermostat_monitor_temperature_manage_monitor_interface_GumboX_UnitTests.scala)
- Component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Monitor_Interface_impl_thermostat_monitor_temperature_manage_monitor_interface_DSC_UnitTests/report.html)
- Auto-generated GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Monitor/Manage_Monitor_Interface_impl_thermostat_monitor_temperature_manage_monitor_interface_GumboX_UnitTests.scala)
- Auto-generated component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Monitor_Interface_impl_thermostat_monitor_temperature_manage_monitor_interface_DSC_UnitTests/report.html)

- Configurations for the Initialize Entrypoint
<table>
Expand All @@ -255,8 +255,8 @@ likely would be excluded in a release build

#### <!--start__isolette_gumbox-unit-testing-setup_configurations_mmm_configurations-title-->MMM<!--end____isolette_gumbox-unit-testing-setup_configurations_mmm_configurations-title-->
<!--start__isolette_gumbox-unit-testing-setup_configurations_mmm_configurations-description-->
- GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Monitor/Manage_Monitor_Mode_impl_thermostat_monitor_temperature_manage_monitor_mode_GumboX_UnitTests.scala)
- Component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Monitor_Mode_impl_thermostat_monitor_temperature_manage_monitor_mode_DSC_UnitTests/report.html)
- Auto-generated GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Monitor/Manage_Monitor_Mode_impl_thermostat_monitor_temperature_manage_monitor_mode_GumboX_UnitTests.scala)
- Auto-generated component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Monitor_Mode_impl_thermostat_monitor_temperature_manage_monitor_mode_DSC_UnitTests/report.html)

- Configurations for the Initialize Entrypoint
<table>
Expand All @@ -273,8 +273,8 @@ likely would be excluded in a release build

#### <!--start__isolette_gumbox-unit-testing-setup_configurations_mhs_configurations-title-->MHS<!--end____isolette_gumbox-unit-testing-setup_configurations_mhs_configurations-title-->
<!--start__isolette_gumbox-unit-testing-setup_configurations_mhs_configurations-description-->
- GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Regulate/Manage_Heat_Source_impl_thermostat_regulate_temperature_manage_heat_source_GumboX_UnitTests.scala)
- Component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Heat_Source_impl_thermostat_regulate_temperature_manage_heat_source_DSC_UnitTests/report.html)
- Auto-generated GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Regulate/Manage_Heat_Source_impl_thermostat_regulate_temperature_manage_heat_source_GumboX_UnitTests.scala)
- Auto-generated component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Heat_Source_impl_thermostat_regulate_temperature_manage_heat_source_DSC_UnitTests/report.html)

- Configurations for the Initialize Entrypoint
<table>
Expand All @@ -291,8 +291,8 @@ likely would be excluded in a release build

#### <!--start__isolette_gumbox-unit-testing-setup_configurations_mri_configurations-title-->MRI<!--end____isolette_gumbox-unit-testing-setup_configurations_mri_configurations-title-->
<!--start__isolette_gumbox-unit-testing-setup_configurations_mri_configurations-description-->
- GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Regulate/Manage_Regulator_Interface_impl_thermostat_regulate_temperature_manage_regulator_interface_GumboX_UnitTests.scala)
- Component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Regulator_Interface_impl_thermostat_regulate_temperature_manage_regulator_interface_DSC_UnitTests/report.html)
- Auto-generated GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Regulate/Manage_Regulator_Interface_impl_thermostat_regulate_temperature_manage_regulator_interface_GumboX_UnitTests.scala)
- Auto-generated component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Regulator_Interface_impl_thermostat_regulate_temperature_manage_regulator_interface_DSC_UnitTests/report.html)

- Configurations for the Initialize Entrypoint
<table>
Expand All @@ -308,8 +308,8 @@ likely would be excluded in a release build

#### <!--start__isolette_gumbox-unit-testing-setup_configurations_mrm_configurations-title-->MRM<!--end____isolette_gumbox-unit-testing-setup_configurations_mrm_configurations-title-->
<!--start__isolette_gumbox-unit-testing-setup_configurations_mrm_configurations-description-->
- GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Regulate/Manage_Regulator_Mode_impl_thermostat_regulate_temperature_manage_regulator_mode_GumboX_UnitTests.scala)
- Component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Regulator_Mode_impl_thermostat_regulate_temperature_manage_regulator_mode_DSC_UnitTests/report.html)
- Auto-generated GUMBOX Unit Test Harness [link](hamr/slang/src/test/bridge/isolette/Regulate/Manage_Regulator_Mode_impl_thermostat_regulate_temperature_manage_regulator_mode_GumboX_UnitTests.scala)
- Auto-generated component coverage report using the configurations below [link](https://people.cs.ksu.edu/~santos_jenkins/pub/gumbox-journal/custom_configs/isolette/Manage_Regulator_Mode_impl_thermostat_regulate_temperature_manage_regulator_mode_DSC_UnitTests/report.html)

- Configurations for the Initialize Entrypoint
<table>
Expand Down
3 changes: 2 additions & 1 deletion readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# GUMBOX 2024 Case Studies

The following provide links to the GUMBOX case studies as presented in the FMICS 2024 Journal. The earlier version of these case studies as presented in the FMICS 2023 conference are available [here](https://github.com/santoslab/gumbox-case-studies/tree/paper_version/readme.md)

## [Periodic Temperature Control](temp_control/periodic/readme.md)


Expand All @@ -9,4 +11,3 @@
## [RTS](rts/readme.md)


The GUMBOX case studies for the FMICS 2023 conference are available [here](https://github.com/santoslab/gumbox-case-studies/tree/paper_version/readme.md)
14 changes: 7 additions & 7 deletions report/readme-gen/src/main/report/Report.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -437,12 +437,12 @@ object Report {
ret = ret :+ content
}

val optLink: Option[ST] =
val optText: (Option[ST], Option[ST]) =
if (componentArtifact.componentNickName == "MA" ||componentArtifact.componentNickName == "TempControl")
Some(
st"""<br>
|*(Custom configurations were used for this component. Click [here](${ReadmeGen.rootDefaultConfigCoverageLink}/${project.coverageRootName}/${componentArtifact.simpleDscHarnessName}/report.html) for the coverage report obtained when only the default configurations are used)*""")
else None()
(Some(st", that was subsequently modified to provide custom configurations"),
Some(st""". Custom configurations were used for this component. Click [here](${ReadmeGen.rootDefaultConfigCoverageLink}/${project.coverageRootName}/${componentArtifact.simpleDscHarnessName}/report.html)
|for the coverage report obtained when only the default configurations are used"""))
else (None(), None())

val coverageLink: String = s"[link](${ReadmeGen.rootCustomConfigCoverageLink}/${project.coverageRootName}/${componentArtifact.simpleDscHarnessName}/report.html)"
val relly = project.projectRootDir.relativize(componentArtifact.manualTestingFilename)
Expand All @@ -451,8 +451,8 @@ object Report {
tag = createTag(s"${componentArtifact.componentFullName}_configurations"),
title = Some(st"${componentArtifact.componentNickName}"),
description = Some(
st"""- GUMBOX Unit Test Harness [link](${relly})
|- Component coverage report using the configurations below ${coverageLink}$optLink
st"""- Auto-generated GUMBOX Unit Test Harness [link](${relly})${optText._1}
|- Auto-generated component coverage report using the configurations below ${coverageLink}${optText._2}
|
| ${(ret, "\n")}"""),
content = ISZ(),
Expand Down
Loading

0 comments on commit 37edef3

Please sign in to comment.