Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.4 KB

File metadata and controls

28 lines (21 loc) · 1.4 KB

Contributing

A dataset is one YAML file in emdatabase/index/. To add one, fill in the new-dataset issue form and an action turns it into that file and opens the pull request for you. The Add Dataset page says what to have ready: one download link - a Google Drive share link included - a description, the licence, the technique, and the authors as Name; Affiliation; ORCID, one per line.

If you would rather stay in a terminal, run

python -m emdatabase.new_dataset https://zenodo.org/records/<record>/files/<file>

which fetches the checksum and size, prompts for the rest and writes the file. Model weights live in the same index: add --kind weights.

Neither route needs the checksum or the size: an entry missing either one has the file downloaded on GitHub and the fields filled in for it, unless the pull request comes from a fork, whose branch cannot be pushed to.

A dataset that is one file inside a zip on a record nobody can re-publish is written by hand instead, with an archive block naming the zip and the member inside it. download() then fetches only that member, and never the whole archive.

Full instructions, including what to do by hand and what CI checks: https://electronmicroscopy.github.io/emdatabase/contributing.html.