macsyfinder
MacSyFinder - Detection of macromolecular systems in protein datasets using systems modelling and similarity search.
Science Score: 75.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 7 DOI reference(s) in README -
○Academic publication links
-
✓Committers with academic emails
5 of 13 committers (38.5%) from academic institutions -
✓Institutional organization owner
Organization gem-pasteur has institutional domain (research.pasteur.fr) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.1%) to scientific vocabulary
Repository
MacSyFinder - Detection of macromolecular systems in protein datasets using systems modelling and similarity search.
Basic Info
Statistics
- Stars: 62
- Watchers: 9
- Forks: 16
- Open Issues: 2
- Releases: 3
Metadata Files
README.md

MacSyFinder
MacSyFinder - Detection of macromolecular systems in protein datasets using systems modelling and similarity search.
Citations
MacSyFinder v2: Néron, Bertrand; Denise, Rémi; Coluzzi, Charles; Touchon, Marie; Rocha, Eduardo P.C.; Abby, Sophie S. MacSyFinder v2: Improved modelling and search engine to identify molecular systems in genomes. Peer Community Journal, Volume 3 (2023), article no. e28. doi : 10.24072/pcjournal.250. https://peercommunityjournal.org/articles/10.24072/pcjournal.250/
MacSyFinder v1: Abby SS, Néron B, Ménager H, Touchon M, Rocha EPC (2014). MacSyFinder: A Program to Mine Genomes for Molecular Systems with an Application to CRISPR-Cas Systems. PLoS ONE 9(10): e110726. doi:10.1371/journal.pone.0110726 http://www.plosone.org/article/info%3Adoi%2F10.1371%2Fjournal.pone.0110726
What new in MacSyFinder V2.x
https://macsyfinder.readthedocs.io/en/latest/userguide/newv2.html
Installation
[!IMPORTANT] MacSyFinder requires hmmer >= 3.1 (http://hmmer.org/). You need to install hmmer by yourself (except if you install macsyfinder via conda/mamba). If you are a modeler, you will need also
gitThe other dependencies are managed by the python package manager pip.
MacSyFinder is available on pypi
Installation from distribution
We encourage to install macsyfinder in a virtualenv
After creating a virtualenv dedicated to macsyfinder and activating it
python3 -m venv my_project
cd my_project
source bin/activate
you can install macsyfinder as described below:
from pypi
python3 -m pip install macsyfinder==x.x
where x.x is the version number
from conda/mamba
mamba install -c bioconda macsyfinder=x.x
where x.x is the version number
from git repository
git clone https://github.com/gem-pasteur/macsyfinder.git
cd macsyfinder
python3 -m pip install .
for modelers
https://macsyfinder.readthedocs.io/en/latest/modeler_guide/installation.html
for developers
https://macsyfinder.readthedocs.io/en/latest/developer_guide/installation.html
Unit tests
python3 -m unittest discover -vv
for more details about running tests please refer to documentation https://macsyfinder.readthedocs.io/en/latest/developer_guide/installation.html#testing
for more details read https://macsyfinder.readthedocs.io/en/latest/developer_guide/installation.html#macsyfinder-installation-and-testing-procedures
with github actions / coverage / codecov
Models installation
Models are no longer shipped along macsyfinder package. To install Models you can use macsydata.
macsydata allow to manage models stored in macsy-models.
Below some most useful commands.
- available: List Models available on macsy-models.
- search: Discover new packages.
- install: Install or upgarde packages.
- uninstall: Uninstall packages.
- cite: How to cite a package.
- ...
For complete documentation see macsydata section on readthedoc
For models not stored in macsy-models the commands available, search, installation from remote or upgrade from remote are NOT available.
For models Not stored in macsy-models, you have to manage them semi-manually. Download the archive (do not unarchive it), then use macsydata for the installation.
Documentation
You will find complete documentation for setting up your project on readthedocs
Example data sets
Two example datasets with command lines and expected output files are available here and here (for a more thorough one). The 1st dataset is also described in the Documentation.
Docker
MacSyFinder is also available as Docker container
How to use macsyfinder container with docker
The computations are performed under msf user in /home/msf inside the container.
So You have to mount a directory from the host in the container to exchange data (inputs data, and results)
from the host and the container.
The shared directory must be writable by the msf user or overwrite the user in the container by your id (see example below)
Furthermore the models are no longer packaged along macsyfinder. So you have to install them by yourself. For that we provide a command line tool macsydata which is inspired by pip
macsydata search PACKNAME
macsydata install PACKNAME== or >=, or ... VERSION
To work with Docker you have to install models in a directory which will be mounted in the image at run time
mkdir shared_dir
cd shared_dir
# install desired models in my_models
docker run -v ${PWD}/:/home/msf -u $(id -u ${USER}):$(id -g ${USER}) gempasteur/macsyfinder:<tag> macsydata install --target /home/msf/my_models MODELS
# run msf with these models
docker run -v ${PWD}/:/home/msf -u $(id -u ${USER}):$(id -g ${USER}) gempasteur/macsyfinder:<tag> --db-type gembase --models-dir=/home/msf/my_models/ --models TFF-SF Archaeal-T4P ComM MSH T2SS T4bP T4P Tad --sequence-db my_genome.fasta -w 12
How to use with apptainer (formely Singularity)
As the docker image is registered in docker hub you can also use it directly with apptainer.
Unlike docker you have not to worry about shared directory, your home and /tmp are automatically shared.
apptainer run -H ${HOME} docker://gempasteur/macsyfinder:<tag> macsydata install --target my_models MODELS
apptainer run -H ${HOME} docker://gempasteur/macsyfinder:<tag> macsyfinder --db-type gembase --models-dir=my_models --models TFF-SF Archaeal-T4P ComM MSH T2SS T4bP T4P Tad --sequence-db my_genome.fasta -w 12
Licence:
MacSyFinder is developed and released under
Contributing
We encourage contributions, bug report, enhancement ...
But before to do that, we encourage to read the contributing guide.
Contributors
List of all people who participated in the macsyfinder project.
Note
The setsid binary in utils directory is used only for functional tests on macosx.
The binary has been build using the setsid-macosx project.
Owner
- Name: gem-pasteur
- Login: gem-pasteur
- Kind: organization
- Website: https://research.pasteur.fr/en/team/microbial-evolutionary-genomics/
- Repositories: 5
- Profile: https://github.com/gem-pasteur
Citation (CITATION.yml)
---
# How to cite macsyfinder
# below the citation informations in yaml format
authors:
- Néron Bertrand
- Denise Rémi
- Coluzzi Charles
- Touchon Marie
- Rocha Eduardo PC.
- Abby Sophie
-
date: 2023
title: "MacSyFinder v2: Improved modelling and search engine to identify molecular systems in genomes."
journal:
title: Peer Community Journal
volume: 3
enumber: e28
doi: 10.24072/pcjournal.250
url: https://peercommunityjournal.org/articles/10.24072/pcjournal.250/
# below a more human readable and traditional version
# Néron, Bertrand; Denise, Rémi; Coluzzi, Charles; Touchon, Marie; Rocha, Eduardo P.C.; Abby, Sophie S.
# MacSyFinder v2: Improved modelling and search engine to identify molecular systems in genomes.
# Peer Community Journal, Volume 3 (2023), article no. e28.
# doi : 10.24072/pcjournal.250.
# https://peercommunityjournal.org/articles/10.24072/pcjournal.250/
CodeMeta (codemeta.json)
{
"@context": "https://w3id.org/codemeta/3.0",
"type": "SoftwareSourceCode",
"applicationCategory": "Biology",
"author": [
{
"id": "https://orcid.org/0000-0002-0220-0482",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": "Institut Pasteur, Université Paris Cité, Bioinformatics and Biostatistics HUB, Paris, France "
},
"email": "bneron@pasteur.fr",
"familyName": "Néron",
"givenName": "Bertrand"
},
{
"id": "https://orcid.org/0000-0002-5231-3346",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": " Univ. Grenoble Alpes, CNRS, UMR 5525, VetAgro Sup, Grenoble INP, TIMC, 38000 Grenoble, France "
},
"email": "sophie.abby@univ-grenoble-alpes.fr",
"familyName": "Abby",
"givenName": "Sophie"
},
{
"id": "https://orcid.org/0000-0001-7704-822X",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": "Institut Pasteur, Université Paris Cité, CNRS UMR3525, Microbial Evolutionary Genomics, Paris, France"
},
"email": "erocha@pasteur.fr",
"familyName": "Rocha",
"givenName": "Eduardo"
}
],
"codeRepository": "https://github.com/gem-pasteur/macsyfinder",
"contributor": [
{
"id": "https://orcid.org/0000-0002-7552-1009",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": "Institut Pasteur, Université Paris Cité, Bioinformatics and Biostatistics HUB, Paris, France "
},
"email": "hmenager@pasteur.fr",
"familyName": "Ménager",
"givenName": "Hervé"
},
{
"id": "https://github.com/fjossandon",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": "Biome Makers Inc."
},
"email": "fco.j.ossandon@gmail.com",
"familyName": "Ossandon",
"givenName": "Franscisco J,"
},
{
"id": "https://orcid.org/0000-0003-2277-689X",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": "APC Microbiome Institute: Cork, IE "
},
"familyName": "Denise",
"givenName": "Rémi"
},
{
"id": "https://orcid.org/0000-0001-7389-447X",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": "Institut Pasteur, Université Paris Cité, CNRS UMR3525, Microbial Evolutionary Genomics, Paris, France"
},
"email": "mtouchon@pasteur.fr",
"familyName": "Touchon",
"givenName": "Marie"
},
{
"id": "https://orcid.org/0000-0003-4797-6185",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": "Institut Pasteur, Université Paris Cité, CNRS UMR3525, Microbial Evolutionary Genomics, Paris, France"
},
"email": "aperrin@pasteur.fr",
"familyName": "Perrin",
"givenName": "Amandine"
},
{
"id": "https://orcid.org/0000-0002-0930-8920",
"type": "Person",
"affiliation": {
"type": "Organization",
"name": "Institut Pasteur, Université Paris Cité, SeqBio, Paris, France "
},
"email": "yoann.dufresne@pasteur.fr",
"familyName": "Dufresne",
"givenName": "Yoann"
},
{
"id": "https://github.com/TrellixVulnTeam",
"type": "Person",
"email": "charles.mcfarland@trellix.com",
"givenName": "TrellixVulnTeam"
},
{
"id": "https://orcid.org/0000-0002-2961-9670",
"type": "Person",
"email": "crusoe@debian.org",
"familyName": "Crusoe",
"givenName": "Michael R."
}
],
"dateCreated": "2013-11-04",
"dateModified": "2024-07-30",
"datePublished": "2014-10-17",
"description": "MacSyFinder is a program to model and detect macromolecular systems, genetic pathways… in prokaryotes protein datasets.",
"downloadUrl": "https://pypi.org/project/MacSyFinder/",
"funder": {
"type": "Organization",
"name": "Institut Pasteur Paris"
},
"keywords": [
"bioinformatics",
"functional genomics",
"gene functional annotation"
],
"license": "https://spdx.org/licenses/GPL-3.0+",
"name": "macsyfinder",
"operatingSystem": [
"Linux",
"BSD",
"macOS"
],
"programmingLanguage": "Python",
"relatedLink": [
"https://pypi.org/project/MacSyFinder/",
"https://hub.docker.com/r/gempasteur/macsyfinder"
],
"softwareRequirements": [
"Python >= 3.10",
"hmmer >= 3.1"
],
"version": "2.1.4",
"codemeta:contIntegration": {
"id": "https://github.com/gem-pasteur/macsyfinder/actions"
},
"continuousIntegration": "https://github.com/gem-pasteur/macsyfinder/actions",
"developmentStatus": "active",
"issueTracker": "https://github.com/gem-pasteur/macsyfinder/issues",
"referencePublication": "https://doi.org/10.24072/pcjournal.250"
}
GitHub Events
Total
- Issues event: 2
- Watch event: 8
- Delete event: 1
- Issue comment event: 7
- Push event: 8
- Create event: 1
Last Year
- Issues event: 2
- Watch event: 8
- Delete event: 1
- Issue comment event: 7
- Push event: 8
- Create event: 1
Committers
Last synced: almost 3 years ago
All Time
- Total Commits: 2,879
- Total Committers: 13
- Avg Commits per committer: 221.462
- Development Distribution Score (DDS): 0.216
Top Committers
| Name | Commits | |
|---|---|---|
| Bertrand Néron | b****n@p****r | 2,256 |
| Sophie Abby | s****y@g****m | 248 |
| Jerome Raciazek | j****k@p****r | 184 |
| saphia | s****y@u****r | 131 |
| sabby | s****y@f****r | 24 |
| Amandine PERRIN | a****n@p****r | 9 |
| free hacker | f****r@g****m | 7 |
| saphia | s****y@p****r | 7 |
| Francisco J. Ossandon | f****n@g****m | 6 |
| abbys | a****s@t****l | 4 |
| jeanrjc | j****c@u****m | 1 |
| TrellixVulnTeam | c****d@t****m | 1 |
| Jerome | j****k@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 72
- Total pull requests: 5
- Average time to close issues: about 1 year
- Average time to close pull requests: 11 days
- Total issue authors: 50
- Total pull request authors: 5
- Average comments per issue: 2.54
- Average comments per pull request: 1.6
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 3
- Pull requests: 1
- Average time to close issues: about 2 months
- Average time to close pull requests: 26 days
- Issue authors: 3
- Pull request authors: 1
- Average comments per issue: 4.33
- Average comments per pull request: 1.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- bneron (6)
- saphia (6)
- jeanrjc (3)
- lguy (3)
- sarah872 (2)
- jpjarnoux (2)
- dineshkumarsrk (2)
- tillea (2)
- liangcmu (2)
- NelleV (2)
- lkj66666 (2)
- vbrover (2)
- cschu (2)
- altaetran (1)
- YanpingHu (1)
Pull Request Authors
- mr-c (2)
- fjossandon (1)
- freeh4cker (1)
- TrellixVulnTeam (1)
- bgoas (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 187 last-month
- Total dependent packages: 1
- Total dependent repositories: 3
- Total versions: 13
- Total maintainers: 1
pypi.org: macsyfinder
MacSyFinder: Detection of macromolecular systems in protein datasets using systems modelling and similarity search
- Homepage: https://github.com/gem-pasteur/macsyfinder/
- Documentation: https://macsyfinder.readthedocs.io/en/latest/
- License: gpl-3.0
-
Latest release: 2.1.5
published 6 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- codecov/codecov-action v3 composite
- registry-gitlab.pasteur.fr/gem/macsyfinder/run_dep latest build
- registry-gitlab.pasteur.fr/gem/macsyfinder/run_dep latest build
- ubuntu focal build
- pygraphviz *
- sphinx-rtd-theme *
- sphinx_autodoc_typehints *
- sphinxcontrib-applehelp *
- sphinxcontrib-devhelp *
- sphinxcontrib-htmlhelp *
- sphinxcontrib-jsmath *
- sphinxcontrib-qthelp *
- sphinxcontrib-serializinghtml *
- sphinxcontrib-svg2pdfconverter *