IO hub for Cryo-EM, Cryo-ET and subtomogram averaging data.
Project description
naaf
naaf is a library for reading and writing Cryo-ET data based on the cryotypes specification.
Installation
pip install naaf
Usage
naaf provides granular I/O functions such as read_star and read_mrc, which will all return objects following the cryotypes specification. A higher level function called read adds some magic to the IO procedure, guessing file formats and returning a list of cryotypes.
Similarly to the read_* functions, naaf provides a series of write_* functions.
From the command line
If you just need to quickly inspect your data, this command will land in an ipython shell with the loaded data collected in a list called data:
naaf path/to/files/* /other/path/to/file.star
Features
Currently naaf is capable of reading images in the following formats:
.mrc(and the.mrcsor.stvariants)- Dynamo
.em
and particle data in the following formats:
- Relion
.star - Dynamo
.tbl - Cryolo
.cboxand.box
Writer functions currently exist for:
.mrc- Dynamo
.em - Relion
.star - Dynamo
.tbl
Image data
When possible (and unless disabled), naaf loads images lazily using dask. The resulting objects can be treated as normal numpy array, except one needs to call array.compute() to apply any pending operations and return the result.
Contributing
Contributions are more than welcome! If there is a file format that you wish were supported in reading or writing, simply open an issue about it pointing to the specification. Alternatively, feel free to open a PR with your proposed implementation; you can look at the existing functions for inspiration.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file naaf-0.3.1.tar.gz.
File metadata
- Download URL: naaf-0.3.1.tar.gz
- Upload date:
- Size: 30.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
926dee35e3d7bfbab5fb7d1d3f103260bfd10a391d3f992291fae0628a18daea
|
|
| MD5 |
bfedc25bf072a6e692c90f208ef7fadc
|
|
| BLAKE2b-256 |
583398d79c26b023a479f015d3ab0318740992c24c38d0d606177b1a9333189f
|
File details
Details for the file naaf-0.3.1-py2.py3-none-any.whl.
File metadata
- Download URL: naaf-0.3.1-py2.py3-none-any.whl
- Upload date:
- Size: 34.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b5c38ccbb9cd3d6c0d0379a639d06bddae79417655b2bf48f04cb5d3b923cfaf
|
|
| MD5 |
1e5f56b3c41937e27ad989433ab1e8d9
|
|
| BLAKE2b-256 |
807e3b9851056d66d4fcaa7fd27ea7fe99021270f050ffb4e1fef95d8dcd0cb1
|