Skip to content

Commit

Permalink
Merge branch 'main' into feat/event-ui-auto
Browse files Browse the repository at this point in the history
  • Loading branch information
brauliorivas authored Jun 26, 2024
2 parents 8621fe7 + a7b49eb commit 69d3005
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/development.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Release version of dmX in GitHub Pages
name: Release version of eede in GitHub Pages
on:
push:
branches: [release]
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}

Expand All @@ -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

Expand All @@ -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
2 changes: 1 addition & 1 deletion .github/workflows/static.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Deploy dmX to GitHub Pages
name: Deploy eede to GitHub Pages
on:
push:
branches: [main]
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<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">
Expand All @@ -30,7 +30,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">
Expand Down
10 changes: 5 additions & 5 deletions model/MODEL.md
Original file line number Diff line number Diff line change
@@ -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?

Expand All @@ -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

Expand All @@ -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.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 6 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "dmx",
"name": "eede",
"type": "module",
"version": "1.0.0",
"scripts": {
Expand All @@ -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"
}
Expand Down

0 comments on commit 69d3005

Please sign in to comment.