Merge branch 'feat/contact-modal' into feat/mc-reco-view

key4hep · Jun 26, 2024 · 8c0135c · 8c0135c
2 parents b030b93 + cde2b3c
commit 8c0135c
Show file tree

Hide file tree

Showing 20 changed files with 97 additions and 51 deletions.
diff --git a/.github/workflows/development.yml b/.github/workflows/development.yml
@@ -1,4 +1,4 @@
-name: Release version of dmX in GitHub Pages
+name: Release version of eede in GitHub Pages
 on:
     push:
         branches: [release]

diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml
@@ -10,7 +10,7 @@ on:
 
 jobs:
     test:
-        uses: key4hep/dmx/.github/workflows/test-previews.yml@main
+        uses: key4hep/eede/.github/workflows/test-previews.yml@main
         with:
             repository: ${{ github.event.pull_request.head.sha }}
 
@@ -34,7 +34,7 @@ jobs:
                   source-dir: .
                   preview-branch: gh-pages
                   umbrella-dir: pr-preview
-                  deploy-repository: "key4hep/dmx"
+                  deploy-repository: "key4hep/eede"
                   token: ${{ secrets.PR_TOKEN }}
                   action: auto
 
@@ -45,6 +45,6 @@ jobs:
                   source-dir: .
                   preview-branch: gh-pages
                   umbrella-dir: pr-preview
-                  deploy-repository: "key4hep/dmx"
+                  deploy-repository: "key4hep/eede"
                   token: ${{ secrets.PR_TOKEN }}
                   action: remove
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -1,4 +1,4 @@
-name: Deploy dmX to GitHub Pages
+name: Deploy eede to GitHub Pages
 on:
     push:
         branches: [main]

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2023, CERN
+Copyright (c) 2024, CERN
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
-# dmX
-*data model eXplorer*
+# eede
+*EDM4hep Event Data Explorer*
 
 Warning: **Experimental**
 
-Explore your events at [dmX](https://key4hep.github.io/dmx/).
+Explore your events at [eede](https://key4hep.github.io/eede/).
 
 To generate your `.json` file use `edm4hep2json` available in the Key4hep stack.
 Example usage for the events from FCC `winter2023` campaign:

diff --git a/css/dmx-logo.css b/css/dmx-logo.css
diff --git a/css/logo.css b/css/logo.css
@@ -0,0 +1,22 @@
+.logo-letter {
+  font-style: italic;
+  font-size: 45px;
+  font-family: serif;
+}
+
+.e1 {
+  color: #6e84f8;
+}
+
+.e2 {
+  color: #2b3fa4;
+}
+
+.d {
+  color: #653668;
+}
+
+.e3 {
+  color: #9e2c2c;
+  font-size: 50px;
+}
diff --git a/favicon.ico b/favicon.ico
diff --git a/img/braulio-email.png b/img/braulio-email.png
diff --git a/img/braulio-email.webp b/img/braulio-email.webp
diff --git a/img/dmx_logo.png b/img/dmx_logo.png
diff --git a/img/eede-logo.svg b/img/eede-logo.svg
diff --git a/img/juraj-email.png b/img/juraj-email.png
diff --git a/img/juraj-email.webp b/img/juraj-email.webp
diff --git a/img/thomas-email.png b/img/thomas-email.png
diff --git a/img/thomas-email.webp b/img/thomas-email.webp
diff --git a/index.html b/index.html
@@ -4,11 +4,11 @@
 
 <head>
   <meta charset="utf-8" />
-  <title>dmX</title>
+  <title>eede</title>
   <link rel="icon" type="image/x-icon" href="./favicon.ico">
 
   <link rel="stylesheet" href="css/main.css">
-  <link rel="stylesheet" href="css/dmx-logo.css">
+  <link rel="stylesheet" href="css/logo.css">
   <link rel="stylesheet" href="css/canvas.css">
   <link rel="stylesheet" href="css/modal.css">
   <link rel="stylesheet" href="css/toggle.css">
@@ -23,7 +23,8 @@
     <div class="modal-content">
 
       <p>Welcome to <span id="logo">
-          <span class="logo-d">d</span><span class="logo-m">m</span><span class="logo-x">X</span>
+          <span class="logo-letter e1">e</span><span class="logo-letter e2">e</span><span
+            class="logo-letter d">d</span><span class="logo-letter e3">E</span>
         </span></p>
 
       <div id="input-message">
@@ -33,7 +34,7 @@
           <label class="mr-10" for="input-file">Select EDM4hep JSON:</label>
           <input id="input-file" name="input-file" type="file" accept=".json">
           <p class="small-text ml-20">Example input file (right click to save): <a
-              href="https://fccsw.web.cern.ch/fccsw/dmx/p8_ee_ZH_ecm240.edm4hep.json">p8_ee_ZH_ecm240.edm4hep.json</a>
+              href="https://fccsw.web.cern.ch/fccsw/eede/p8_ee_ZH_ecm240.edm4hep.json">p8_ee_ZH_ecm240.edm4hep.json</a>
           </p>
         </div>
         <div id="event-selector">
@@ -92,22 +93,23 @@
   <div id="information-modal">
     <img id="close-information" src="img/close.svg" alt="Close" width="35" height="35" />
     <div class="info-modal-content">
-      <span class="logo-d">d</span><span class="logo-m">m</span><span class="logo-x">X</span>
-      <p>Welcome to dmX, an Event Data Explorer for EDM4hep. Learn more about dmX on the <a
-          href="https://github.com/key4hep/dmx/wiki" target="_blank" rel="noopener noreferrer">wiki</a>.
+      <span class="logo-letter e1">e</span><span class="logo-letter e2">e</span><span
+        class="logo-letter d">d</span><span class="logo-letter e3">E</span>
+      <p>Welcome to eede, an EDM4hep Event Data Explorer. Learn more about eede on the <a
+          href="https://github.com/key4hep/eede/wiki" target="_blank" rel="noopener noreferrer">wiki</a>.
         Want to learn more about EDM4hep? Check out the <a href="https://edm4hep.web.cern.ch" target="_blank"
           rel="noopener noreferrer">EDM4hep</a> website.
       </p>
       <p>
-        Found a bug or have a feature request? Open a new <a href="https://github.com/key4hep/dmx/issues"
+        Found a bug or have a feature request? Open a new <a href="https://github.com/key4hep/eede/issues"
           target="_blank" rel="noopener noreferrer">issue</a>.
       </p>
       <p>Contact:</p>
       <ul>
         <li class="contact-element">Juraj Smiesko:
           <address class="email">
             <a href="mailto:[email protected]">
-              <img src="img/juraj-email.png" alt="juraj-email" height="21px" />
+              <img src="img/juraj-email.webp" alt="juraj-email" height="21px" />
             </a>
           </address>
           <button class="copy-email-button" data-email="[email protected]">
@@ -120,7 +122,7 @@
         <li class="contact-element">Thomas Madlener:
           <address class="email">
             <a href="mailto:[email protected]">
-              <img src="img/thomas-email.png" alt="thomas-email" height="21px" />
+              <img src="img/thomas-email.webp" alt="thomas-email" height="21px" />
             </a>
           </address>
           <button class="copy-email-button" data-email="[email protected]">
@@ -132,7 +134,7 @@
         <li class="contact-element">Braulio Rivas:
           <address class="email">
             <a href="mailto:[email protected]">
-              <img src="img/braulio-email.png" alt="braulio-email" height="21px" />
+              <img src="img/braulio-email.webp" alt="braulio-email" height="21px" />
             </a>
           </address>
           <button class="copy-email-button" data-email="[email protected]">

diff --git a/model/MODEL.md b/model/MODEL.md
@@ -1,6 +1,6 @@
-# Keeping dmx up to date
+# Keeping eede up to date
 
-To keep dmx up to date with the event data model [edm4hep](https://github.com/key4hep/EDM4hep), we need a way to get the latest information for each datatype and component. Also, we need to take into account that dmx is deployed on github pages as a static website, so we need a way to update this info without having a server running.
+To keep eede up to date with the event data model [edm4hep](https://github.com/key4hep/EDM4hep), we need a way to get the latest information for each datatype and component. Also, we need to take into account that eede is deployed on github pages as a static website, so we need a way to update this info without having a server running.
 
 ## How to get the latest information?
 
@@ -16,7 +16,7 @@ will download the latest information from the edm4hep, by using the file called
 npm run build
 ```
 
-will generate a file called `datatypes.js` under `output` directory, where all the information is parsed and stored in a format that can be used by the dmx application.
+will generate a file called `datatypes.js` under `output` directory, where all the information is parsed and stored in a format that can be used by the eede application.
 
 ## All at once
 
@@ -26,9 +26,9 @@ You can also run
 npm run update
 ```
 
-to run both processes at once and immediately update the dmx application.
+to run both processes at once and immediately update the eede application.
 
 ## Further improvements
 
 -   We could trigger the update process automatically when a new release of edm4hep is published, but for now, we will keep it simple and run the update process manually.
--   To maintain backward compatibility, we could add a versioning system so we can later load different versions of the edm4hep data model into dmx, however we currently load the latest version.
+-   To maintain backward compatibility, we could add a versioning system so we can later load different versions of the edm4hep data model into eede, however we currently load the latest version.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-	"name": "dmx",
+	"name": "eede",
 	"type": "module",
 	"version": "1.0.0",
 	"scripts": {
@@ -14,15 +14,16 @@
 	},
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/key4hep/dmx.git"
+		"url": "https://github.com/key4hep/eede.git"
 	},
 	"keywords": [
-		"dmx",
+		"eede",
+		"EDM4hep",
 		"HEP",
-		"key4hep"
+		"Key4hep"
 	],
 	"license": "BSD-2-Clause",
-	"homepage": "https://key4hep.github.io/dmx/",
+	"homepage": "https://key4hep.github.io/eede/",
 	"dependencies": {
 		"js-yaml": "^4.1.0"
 	}