emdatabase
This is a project for aggregating different Electron Microscopy files which are hosted over different sources. It is intended to simplify downloading example datasets and trained machine learning model weights for tutorials and method validation.
A list of all datasets and model weights can be found in our docs.
Installation
pip install em-database
You can install em-database via pip or as a local install in the usual way. The distribution is named em-database on PyPI; the import name is emdatabase.
Usage
Examples of how to download data and configure storage locations can be found in our docs, as well as in the quantem-tutorials repository.
Adding a dataset
We welcome contributions of new or existing data!
Datasets are described by a YAML file in emdatabase/index/, one entry per file,
validated against emdatabase/index/json-schema.json. The class name is generated
from the top-level key:
MyDataset:
description: What the data is, how it was acquired and how it is calibrated.
source: https://zenodo.org/records/<record>/files
file: MyDataset.zspy
checksum: md5:<hash>
size_bytes: 1200000000
technique:
- 4D-STEM
license: CC-BY-4.0
A dataset may list more than one technique - in-situ 4D-STEM, cryo EELS - and is
then listed under each of them. emdatabase/index/techniques.yaml is the
vocabulary they come from: acquisition (how the data was taken) and ml_task
(what a model does). A dataset declares acquisition techniques only; a
kind: weights entry declares one of those plus the ML tasks it performs.
Submissions go through an issue. Fill in the new dataset issue form and an action writes the file and opens the pull request. For very large datasets it might be easier to use the CLI as described on the Add Dataset page. See CONTRIBUTING.md.
Metadata
Release files for em-database 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| em_database-0.5.0.tar.gz | 79.0 kB | Without provenance | Details for em_database-0.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| em_database-0.5.0-py3-none-any.whl | Python 3 | none | any | Details for em_database-0.5.0-py3-none-any.whl |
Total release size: 175.9 kB
Release files / em_database-0.5.0.tar.gz
| Download URL | em_database-0.5.0.tar.gz |
|---|---|
| Size | 79.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d3701ea83b96aeba8b2925d794cbbdb5a3da08516e142b35de82ff18dd1059bd
|
|
BLAKE2b-256 checksum How to use checksums |
8f1de364a7cb86a066fa3ddaa925e29a3a26dd12b7e0aa6033345a820e5689e4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / em_database-0.5.0-py3-none-any.whl
| Download URL | em_database-0.5.0-py3-none-any.whl |
|---|---|
| Size | 96.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5a0a9dccf985946866191a41174fb37ef26624ec2d27ce5adc499182e9cae1d5
|
|
BLAKE2b-256 checksum How to use checksums |
36cf4322211446be4bf6fa1b46b195e48e36baf041b07d6cb1ef56d25e4e98e2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for em-database 0.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.