psims
A declarative API for writing XML documents for HUPO PSI-MS mzML and mzIdentML
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
✓DOI references
Found 2 DOI reference(s) in README -
○Academic publication links
-
✓Committers with academic emails
1 of 4 committers (25.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (6.7%) to scientific vocabulary
Keywords
Repository
A declarative API for writing XML documents for HUPO PSI-MS mzML and mzIdentML
Basic Info
- Host: GitHub
- Owner: mobiusklein
- License: apache-2.0
- Language: Python
- Default Branch: master
- Homepage: https://mobiusklein.github.io/psims/
- Size: 231 MB
Statistics
- Stars: 22
- Watchers: 3
- Forks: 10
- Open Issues: 4
- Releases: 0
Topics
Metadata Files
README.md
psims
Prototype work for a unified API for writing Proteomics Standards Initiative standardized formats for mass spectrometry:
- mzML
- mzIdentML
- mzMLb
See the Documenation for more information
Installation
With pip:
sh
pip install psims
With conda:
sh
conda install -c bioconda -c conda-forge -c defaults psims
mzML Minimal Example
```python from psims.mzml.writer import MzMLWriter
Load the data to write
scans = getscandata()
with MzMLWriter(open("out.mzML", 'wb'), close=True) as out: # Add default controlled vocabularies out.controlledvocabularies() # Open the run and spectrum list sections with out.run(id="myanalysis"): spectrumcount = len(scans) + sum([len(products) for _, products in scans]) with out.spectrumlist(count=spectrumcount): for scan, products in scans: # Write Precursor scan out.writespectrum( scan.mzarray, scan.intensityarray, id=scan.id, params=[ "MS1 Spectrum", {"ms level": 1}, {"total ion current": sum(scan.intensityarray)} ]) # Write MSn scans for prod in products: out.writespectrum( prod.mzarray, prod.intensityarray, id=prod.id, params=[ "MSn Spectrum", {"ms level": 2}, {"total ion current": sum(prod.intensityarray)} ], # Include precursor information precursorinformation={ "mz": prod.precursormz, "intensity": prod.precursorintensity, "charge": prod.precursorcharge, "scanid": prod.precursorscanid, "activation": ["beam-type collisional dissociation", {"collision energy": 25}], "isolationwindow": [prod.precursormz - 1, prod.precursormz, prod.precursormz + 1] }) ```
Citing
If you use psims in an academic project, please cite:
Klein, J. A., & Zaia, J. (2018). psims - A declarative writer for mzML and mzIdentML for Python. Molecular & Cellular Proteomics, mcp.RP118.001070. https://doi.org/10.1074/mcp.RP118.001070
Owner
- Name: Joshua Klein
- Login: mobiusklein
- Kind: user
- Location: Boston
- Repositories: 87
- Profile: https://github.com/mobiusklein
GitHub Events
Total
- Issues event: 2
- Watch event: 2
- Issue comment event: 7
- Push event: 2
- Create event: 1
Last Year
- Issues event: 2
- Watch event: 2
- Issue comment event: 7
- Push event: 2
- Create event: 1
Committers
Last synced: over 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Joshua Klein | m****n@g****m | 450 |
| Sean Peters | s****s@c****u | 2 |
| Johannes Leufken | j****n@m****e | 1 |
| Ralf Gabriels | r****g@h****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 18
- Total pull requests: 5
- Average time to close issues: 2 months
- Average time to close pull requests: 4 days
- Total issue authors: 12
- Total pull request authors: 4
- Average comments per issue: 4.61
- Average comments per pull request: 1.0
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 0.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- bretttully (4)
- lars-kolbowski (2)
- levitsky (2)
- jspaezp (2)
- RalfG (1)
- sorenwacker (1)
- mafreitas (1)
- mwang87 (1)
- bkalafut1 (1)
- MKoesters (1)
- ometa-evan (1)
- mobiusklein (1)
Pull Request Authors
- speters-cmri (2)
- RalfG (1)
- JB-MS (1)
- mobiusklein (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 6,289 last-month
- Total docker downloads: 37
- Total dependent packages: 8
- Total dependent repositories: 19
- Total versions: 70
- Total maintainers: 1
pypi.org: psims
Writers and controlled vocabulary manager for PSI-MS's mzML and mzIdentML standards
- Homepage: https://github.com/mobiusklein/psims
- Documentation: https://psims.readthedocs.io/
- License: Apache Software License
-
Latest release: 1.3.5
published about 1 year ago
Rankings
Maintainers (1)
Dependencies
- h5py *
- hdf5plugin *
- hdf5plugin <3.0.0
- lxml *
- numpy *
- pynumpress *
- pyteomics >=4.0.1
- six *
- sqlalchemy *
- lxml *
- numpy *
- six *
- sqlalchemy *
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite