starfile
starfile is a package for reading and writing STAR files in Python.
starfile can be used interactively to inspect/explore files or in scripts and larger software packages to provide basic STAR file I/O functions. Data is exposed as simple python dictionaries or pandas dataframes.
This package was designed principally for compatibility with files generated by RELION.
For more information on working with dataframes, please see the pandas docs.
For starfile specific documentation, see teamtomo.org/starfile
Quickstart
For the following file particles.star with a single data block
data_particles
loop_
_rlnCoordinateX #1
_rlnCoordinateY #2
_rlnCoordinateZ #3
_rlnAngleRot #4
_rlnAngleTilt #5
_rlnAnglePsi #6
_rlnMicrographName #7
91.798700 83.622600 203.341030 -51.740000 173.930000 32.971000 01_10.00Apx.mrc
97.635800 80.437000 203.136160 141.500000 171.760000 -134.680000 01_10.00Apx.mrc
92.415200 88.842700 210.663900 -78.750000 173.930000 87.263200 01_10.00Apx.mrc
94.607830 93.135410 205.425960 -85.215000 167.170000 85.632200 01_10.00Apx.mrc
86.187800 80.125400 204.558750 14.910000 163.260000 -16.030000 01_10.00Apx.mrc
91.824240 76.738300 203.794280 39.740000 168.410000 -57.250000 01_10.00Apx.mrc
98.253300 73.530100 203.856030 73.950000 166.380000 -84.640000 01_10.00Apx.mrc
101.303500 80.290800 194.790400 -178.878000 166.090000 73.181000 01_10.00Apx.mrc
Read the file
import starfile
df = starfile.read('particles.star')
Interact with the data
df['rlnCoordinateX'] += 10
df.head()
rlnCoordinateX rlnCoordinateY rlnCoordinateZ rlnAngleRot rlnAngleTilt rlnAnglePsi rlnMicrographName
0 101.79870 83.62260 203.34103 -51.740 173.93 32.9710 01_10.00Apx.mrc
1 107.63580 80.43700 203.13616 141.500 171.76 -134.6800 01_10.00Apx.mrc
2 102.41520 88.84270 210.66390 -78.750 173.93 87.2632 01_10.00Apx.mrc
3 104.60783 93.13541 205.42596 -85.215 167.17 85.6322 01_10.00Apx.mrc
4 96.18780 80.12540 204.55875 14.910 163.26 -16.0300 01_10.00Apx.mrc
Save the (modified) data to file
starfile.write(df, 'modified_particles.star')
For more advanced usage please check out the examples.
Installation
pip install starfile
5 maintainers
Release files for starfile 0.5.13
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| starfile-0.5.13.tar.gz | 28.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| starfile-0.5.13-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.1 kB
Release files / starfile-0.5.13.tar.gz
| Download URL | starfile-0.5.13.tar.gz |
|---|---|
| Size | 28.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c9562960b06558a35c12e0bd1b8a30b71c4b676733a8b9f222c8ee94a152dc15
|
|
BLAKE2b-256 checksum How to use checksums |
8ec583fd806f8a7c982fb4861171e6761cc1016649ffc3a7ff9cc3f9fd608419
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 2, 2025.
Transparency logRelease files / starfile-0.5.13-py3-none-any.whl
| Download URL | starfile-0.5.13-py3-none-any.whl |
|---|---|
| Size | 10.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2a8cd876121e9183b4594442bc3bd0818964aba66da964e5b2c373984b3c0ce7
|
|
BLAKE2b-256 checksum How to use checksums |
0bd4a4e3e0237574058d3b901971f185a22cb4d1751151b224d4cc44b023f1fa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 2, 2025.
Transparency log
