Publish your research
Your files stay where they are, on your computer or in your GitHub repository. Publishing adds a public page that says what the research is, who made it, what it builds on and what E2ER checked.
1 · Prepare the folder
In the folder that e2er export wrote, run
e2er publish <folder> --owner <handle> --project <name> --name "<Your Name>" --offlineIt checks the folder, writes the dossier and the description (e2er.json) and sends nothing. Add --repo and --commit if the folder is in a GitHub repository, so e2er.org can check the files there too.
2 · Choose it
The files are read in this browser to compare them with their fingerprints. Nothing is uploaded; only the description is published.
3 · Publish
Sent: the description, the dossier and the fingerprint of every file. Not sent: the files, your AI keys, any path on your computer.
-
1 · Sign in
With GitHub, where your research files live, or with ORCID, your researcher iD. You can link both to one profile.
-
2 · Choose your research
Pick the folder that e2er export wrote after your run. It holds the paper, results, code and a list of every file with its fingerprint.
-
3 · E2ER checks it
E2ER opens every file and compares it with the fingerprint recorded when the research was produced. Anything changed afterwards shows up here.
- ✓69 of 69 files unchanged since the run
- ✓Table values match the result files
- ✓33 of 33 references found in bibliographic databases
- ✓16 specialists and the model they used, read from the run's own records
These are the results of the real check of the published showcase.
-
4 · Add details
Templates, specialists, skills and datasets the run used are filled in from its records, so their authors are credited automatically.
-
5 · Published
✓ Your research has a public page
In the real flow it would appear at e2er.org/…. See how the published showcase looks.
For developers: what happens behind the page
Today the same result is reached from the command line. e2er publish verifies the exported folder and writes a description file, e2er.json. That file is added to the public list of research in the repository bhanneke/e2er-site by a pull request; the web flow will open that pull request for you.
e2er publish <folder> --owner <github-login> --project <name> --orcid <iD> --repo <url> --commit <sha>The command is on the development branch registry-publish of E2ER; the PyPI release does not include it yet. Format of e2er.json.