refactor: evaluator documentation and license #10

sergiomrebelo · Aug 28, 2023 · f1b24eb · f1b24eb
1 parent 5402f2a
commit f1b24eb
Show file tree

Hide file tree

Showing 12 changed files with 133 additions and 23 deletions.
diff --git a/src/@evoposter/evaluator/LICENSE.md b/src/@evoposter/evaluator/LICENSE.md
@@ -0,0 +1,19 @@
+Copyright (c) 2023 Sérgio M. Rebelo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/src/@evoposter/evaluator/src/index.mjs b/src/@evoposter/evaluator/src/index.mjs
@@ -1,8 +1,23 @@
 /**
  * Evaluation metrics for evo-poster
- * Sérgio M. Rebelo
- * CDV lab. (CMS, CISUC, Portugal)
- * srebelo[at]dei.uc.pt
+ *
+ * Author: Sérgio M. Rebelo
+ * CMS, CISUC, Portugal
+ * Contact: srebelo[at]dei.uc.pt
+ *
+ * Author and Supervisor: JJ Merelo
+ * UGR + Raku
+ * Contact: jjmerelo[at]gmail.com
+ *
+ * Supervisor: Penousal Machado (supervision)
+ * CMS, CISUC, Portugal
+ * Contact: machado[at]dei.uc.pt
+ *
+ * Supervisor: João Bicker (supervision)
+ * CMS, CISUC, Portugal
+ * Contact: bicker[at]dei.uc.pt
+ *
+ * License: MIT (see LICENSE.md)
  *
  * v0.0.1 July 2023
  */
@@ -18,7 +33,6 @@ import * as WhiteSpaceFraction from "./metrics/WhiteSpaceFraction.mjs";
 import * as TypefaceParing from "./metrics/TypefaceParing.mjs";
 import * as VisualBalance from "./metrics/VisualBalance.mjs";
 
-
 export const legibility = Legibility.compute;
 export const gridAppropriateSize = GridAppropriateSize.compute;
 export const semanticsLayout = SemanticsLayout.compute;
@@ -31,5 +45,5 @@ export const typefaceParing = TypefaceParing.compute;
 export const visualBalance = VisualBalance.compute;
 
 export default () => {
-    console.log (`@evo-poster · evaluator v2.00`)
+    console.log (`👋 @evo-poster · evaluator v2.00`)
 }
diff --git a/src/@evoposter/evaluator/src/metrics/Alignment.mjs b/src/@evoposter/evaluator/src/metrics/Alignment.mjs
@@ -9,10 +9,18 @@
  *
  * return a value between 1 (good) and 0 (bad)
  *
+ *
+ *
  * Author: Sérgio M. Rebelo
- * CDV lab. (CMS, CISUC, Portugal)
+ * CMS, CISUC, Portugal
  * Contact: srebelo[at]dei.uc.pt
  *
+ * Author and Supervisor: JJ Merelo
+ * UGR + Raku
+ * Contact: jjmerelo[at]gmail.com
+ *
+ * License: MIT (see LICENSE.md)
+ *
  * Version 1.0.0 (March 2020)
  * Version: 1.5.0 (November 2023)
  */

diff --git a/src/@evoposter/evaluator/src/metrics/GridAppropriateSize.mjs b/src/@evoposter/evaluator/src/metrics/GridAppropriateSize.mjs
@@ -5,9 +5,17 @@
  * it is related to if the width and height of the grid is
  * in accordance with poster size
  *
- * Sérgio M. Rebelo
- * CDV lab. (CMS, CISUC, Portugal)
- * srebelo[at]dei.uc.pt
+ *
+ *
+ * Author: Sérgio M. Rebelo
+ * CMS, CISUC, Portugal
+ * Contact: srebelo[at]dei.uc.pt
+ *
+ * Author and Supervisor: JJ Merelo
+ * UGR + Raku
+ * Contact: jjmerelo[at]gmail.com
+ *
+ * License: MIT (see LICENSE.md)
  *
  * v1.0.0 November 2023
  */

diff --git a/src/@evoposter/evaluator/src/metrics/Legibility.mjs b/src/@evoposter/evaluator/src/metrics/Legibility.mjs
@@ -7,9 +7,17 @@
  *
  * Expected return a value between 0 (good) and (1) bad
  *
- * Sérgio M. Rebelo
- * CDV lab. (CMS, CISUC, Portugal)
- * srebelo[at]dei.uc.pt
+ *
+ *
+ * Author: Sérgio M. Rebelo
+ * CMS, CISUC, Portugal
+ * Contact: srebelo[at]dei.uc.pt
+ *
+ * Author and Supervisor: JJ Merelo
+ * UGR + Raku
+ * Contact: jjmerelo[at]gmail.com
+ *
+ * License: MIT (see LICENSE.md)
  *
  * v1.0.0 August 2018 (as part of evoPoster)
  * v2.0.0 November 2020 (as part of evoPoster)

diff --git a/src/@evoposter/evaluator/src/metrics/Regularity.mjs b/src/@evoposter/evaluator/src/metrics/Regularity.mjs
@@ -7,10 +7,18 @@
  *
  * return a value between 1 (good) and 0 (bad)
  *
+ *
+ *
  * Author: Sérgio M. Rebelo
- * CDV lab. (CMS, CISUC, Portugal)
+ * CMS, CISUC, Portugal
  * Contact: srebelo[at]dei.uc.pt
  *
+ * Author and Supervisor: JJ Merelo
+ * UGR + Raku
+ * Contact: jjmerelo[at]gmail.com
+ *
+ * License: MIT (see LICENSE.md)
+ *
  * Version 1.0.0 (March 2020)
  * Version: 1.5.0 (November 2023)
  */

diff --git a/src/@evoposter/evaluator/src/metrics/SemanticVisuals.mjs b/src/@evoposter/evaluator/src/metrics/SemanticVisuals.mjs
@@ -10,10 +10,18 @@
  *
  * As of now, the function exclusively considers the predominant emotions from ML analysis.
  *
+ *
+ *
  * Author: Sérgio M. Rebelo
- * CDV lab. (CMS, CISUC, Portugal)
+ * CMS, CISUC, Portugal
  * Contact: srebelo[at]dei.uc.pt
  *
+ * Author and Supervisor: JJ Merelo
+ * UGR + Raku
+ * Contact: jjmerelo[at]gmail.com
+ *
+ * License: MIT (see LICENSE.md)
+ *
  * Version: 1.0.0 (November 2023)
  */
 

diff --git a/src/@evoposter/evaluator/src/metrics/SemanticsEmphasis.mjs b/src/@evoposter/evaluator/src/metrics/SemanticsEmphasis.mjs
@@ -17,9 +17,15 @@
  *
  *
  *
- * Sérgio M. Rebelo
- * CDV lab. (CMS, CISUC, Portugal)
- * srebelo[at]dei.uc.pt
+ * Author: Sérgio M. Rebelo
+ * CMS, CISUC, Portugal
+ * Contact: srebelo[at]dei.uc.pt
+ *
+ * Author and Supervisor: JJ Merelo
+ * UGR + Raku
+ * Contact: jjmerelo[at]gmail.com
+ *
+ * License: MIT (see LICENSE.md)
  *
  * v1.0.0 November 2023
  */

diff --git a/src/@evoposter/evaluator/src/metrics/SemanticsLayout.mjs b/src/@evoposter/evaluator/src/metrics/SemanticsLayout.mjs
@@ -13,9 +13,17 @@
  * RELATIVE mode is related to the composition height
  * FIXED height is related to the container's height
  *
- * Sérgio M. Rebelo
- * CDV lab. (CMS, CISUC, Portugal)
- * srebelo[at]dei.uc.pt
+ *
+ *
+ * Author: Sérgio M. Rebelo
+ * CMS, CISUC, Portugal
+ * Contact: srebelo[at]dei.uc.pt
+ *
+ * Author and Supervisor: JJ Merelo
+ * UGR + Raku
+ * Contact: jjmerelo[at]gmail.com
+ *
+ * License: MIT (see LICENSE.md)
  *
  * v1.0.0 April 2020
  * v2.0.0 November 2023

diff --git a/src/@evoposter/evaluator/src/metrics/TypefaceParing.mjs b/src/@evoposter/evaluator/src/metrics/TypefaceParing.mjs
@@ -17,10 +17,18 @@ import {TYPEFACE_PARING} from "../metrics.config.js";
  *
  * Returns a value between 1 (good) and 0 (bad) to indicate compatibility.
  *
+ *
+ *
  * Author: Sérgio M. Rebelo
- * CDV lab. (CMS, CISUC, Portugal)
+ * CMS, CISUC, Portugal
  * Contact: srebelo[at]dei.uc.pt
  *
+ * Author and Supervisor: JJ Merelo
+ * UGR + Raku
+ * Contact: jjmerelo[at]gmail.com
+ *
+ * License: MIT (see LICENSE.md)
+ *
  * Version 1.0.0 (March 2020)
  * Updated Version: 1.5.0 (November 2023)
  */

diff --git a/src/@evoposter/evaluator/src/metrics/VisualBalance.mjs b/src/@evoposter/evaluator/src/metrics/VisualBalance.mjs
@@ -5,10 +5,17 @@
  * Based on Harrington et al. (2004)
  *
  *
+ *
  * Author: Sérgio M. Rebelo
- * CDV lab. (CMS, CISUC, Portugal)
+ * CMS, CISUC, Portugal
  * Contact: srebelo[at]dei.uc.pt
  *
+ * Author and Supervisor: JJ Merelo
+ * UGR + Raku
+ * Contact: jjmerelo[at]gmail.com
+ *
+ * License: MIT (see LICENSE.md)
+ *
  * Version 1.0.0 (March 2020)
  * Version: 1.5.0 (November 2023)
  */

diff --git a/src/@evoposter/evaluator/src/metrics/WhiteSpaceFraction.mjs b/src/@evoposter/evaluator/src/metrics/WhiteSpaceFraction.mjs
@@ -14,10 +14,18 @@ import {WHITE_SPACE_FRACTION} from "../metrics.config.js";
  * return a value between 1 (good) and 0 (bad)
  * in first version, we used a no-linear method and onlyy works with solid backgrounds
  *
+ *
+ *
  * Author: Sérgio M. Rebelo
- * CDV lab. (CMS, CISUC, Portugal)
+ * CMS, CISUC, Portugal
  * Contact: srebelo[at]dei.uc.pt
  *
+ * Author and Supervisor: JJ Merelo
+ * UGR + Raku
+ * Contact: jjmerelo[at]gmail.com
+ *
+ * License: MIT (see LICENSE.md)
+ *
  * Version 1.0.0 (March 2020)
  * Version: 1.5.0 (November 2023)
  */