From 49cb9e9dfd419bfa0cc482f9d22d8c834ba5ef9c Mon Sep 17 00:00:00 2001 From: Juraj Smiesko <34742917+kjvbrt@users.noreply.github.com> Date: Wed, 26 Jun 2024 10:31:15 +0200 Subject: [PATCH] Renaming dmX into eede --- .github/workflows/development.yml | 2 +- .github/workflows/preview.yml | 6 +++--- .github/workflows/static.yml | 2 +- LICENSE | 2 +- README.md | 6 +++--- index.html | 6 +++--- model/MODEL.md | 10 +++++----- package-lock.json | 4 ++-- package.json | 11 ++++++----- 9 files changed, 25 insertions(+), 24 deletions(-) diff --git a/.github/workflows/development.yml b/.github/workflows/development.yml index 462db31a..4448320f 100644 --- 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 index aa4958ee..97b4669a 100644 --- 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 index f838e0f0..e944a87a 100644 --- 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 index 17e1e5cd..b28264af 100644 --- 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 index 61aa432b..12031515 100644 --- 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/index.html b/index.html index 740a66c9..cea0bd9b 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ - dmX + eede @@ -29,7 +29,7 @@

Example input file (right click to save): p8_ee_ZH_ecm240.edm4hep.json + href="https://fccsw.web.cern.ch/fccsw/eede/p8_ee_ZH_ecm240.edm4hep.json">p8_ee_ZH_ecm240.edm4hep.json

@@ -79,4 +79,4 @@ - + \ No newline at end of file diff --git a/model/MODEL.md b/model/MODEL.md index 3f4bf259..6a515844 100644 --- 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 index 86f79c32..2d42b771 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "dmx", + "name": "eede", "version": "1.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "dmx", + "name": "eede", "version": "1.0.0", "license": "BSD-2-Clause", "dependencies": { diff --git a/package.json b/package.json index ed851530..4ecdd24f 100644 --- 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" }