Skip to content

Commit

Permalink
Added badges to Sirius repo
Browse files Browse the repository at this point in the history
  • Loading branch information
LucaCappelletti94 committed Feb 13, 2024
1 parent 7e20740 commit 8c9905f
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ __pycache__/

# Ignore .idea folder
.idea
.DS_Store
4 changes: 2 additions & 2 deletions bindings/sirius/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[package]
name = "sirius"
name = "sirius-bindings"
version = "0.1.0"
edition = "2021"
license = "GPL-3.0"
readme = "README.md"
keywords = ["metabolomics", "SIRIUS", "LC-MS/MS"]
authors = ["Earth Metabolome Initiative"]
repository = "https://github.com/earth-metabolome-initiative/emi-monorepo/tree/main/bindings/sirius"
description = "Wrapper around SIRIUS CLI. "
description = "Rust bindings for the SIRIUS metabolomics tool"
exclude = ["CONTRIB.md", ".DS_Store", "tests/.DS_Store", ".cargo_vcs_info.json"]

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
12 changes: 7 additions & 5 deletions bindings/sirius/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Sirius
[![Build status](https://github.com/earth-metabolome-initiative/sirius-rs/actions/workflows/sirius.yml/badge.svg)](https://github.com/earth-metabolome-initiative/sirius-rs/actions)
[![Crates.io](https://img.shields.io/crates/v/sirius-rs.svg)](https://crates.io/crates/sirius-rs)
[![Documentation](https://docs.rs/sirius-rs/badge.svg)](https://docs.rs/sirius-rs)

SIRIUS is a java-based software framework for the analysis of LC-MS/MS data of metabolites and other "small molecules of biological interest". SIRIUS integrates a collection of tools, including CSI:FingerID (with [COSMIC](https://bio.informatik.uni-jena.de/software/cosmic/), [ZODIAC](https://bio.informatik.uni-jena.de/software/zodiac/) and [CANOPUS](https://bio.informatik.uni-jena.de/software/canopus/). In particular, both the graphical user interface and the command line version of SIRIUS seamlessly integrate the CSI:FingerID and CANOPUS web services.

For further reading we recommend you to refer to the official [Sirius website](https://bio.informatik.uni-jena.de/software/sirius/).
Expand Down Expand Up @@ -207,12 +211,10 @@ Fuzzing is a technique for finding security vulnerabilities and bugs in software

You can learn more about fuzzing [here](https://github.com/earth-metabolome-initiative/emi-monorepo/tree/sirius-bindings/bindings/sirius/fuzz).

<!--begin cite-->
# Citing Sirius
## Citing Sirius

```bash
Kai Dührkop, Markus Fleischauer, Marcus Ludwig, Alexander A. Aksenov, Alexey V. Melnik, Marvin Meusel, Pieter C. Dorrestein, Juho Rousu, and Sebastian Böcker,
[SIRIUS 4: Turning tandem mass spectra into metabolite structure information.](https://doi.org/10.1038/s41592-019-0344-8)
*Nature Methods* 16, 299–302, 2019.
<!--end cite-->


```

0 comments on commit 8c9905f

Please sign in to comment.