msmpathfinder

Finding pathways from an Markov State Model

https://github.com/moldyn/msmpathfinder

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 3 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
    Organization moldyn has institutional domain (www.moldyn.uni-freiburg.de)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.5%) to scientific vocabulary

Keywords

cpp markov-chain-monte-carlo msm path-sampling pathfinding
Last synced: 6 months ago · JSON representation ·

Repository

Finding pathways from an Markov State Model

Basic Info
  • Host: GitHub
  • Owner: moldyn
  • License: mit
  • Language: C++
  • Default Branch: master
  • Size: 59.6 KB
Statistics
  • Stars: 9
  • Watchers: 0
  • Forks: 3
  • Open Issues: 0
  • Releases: 1
Topics
cpp markov-chain-monte-carlo msm path-sampling pathfinding
Created about 6 years ago · Last pushed over 3 years ago
Metadata Files
Readme License Citation

README.md

MSMPathfinder

Finding pathways from an Markov State Model.

This software package provides tools for finding pathways based on Markov state models. It is required to represent the matrix as an row-normalized matrix, where each row sums up to 1 and all entries are strictly greater 1. This package contains a proof-of-concept implementation of an suggested algorithm (see citations). If the matrix contains more than 100 highly connected states or a few hundred sparsly connected states the MCMC is preferable.

The essential functions are: - MSMPathfinder paths: see citation for further information - MSMPathfinder mcmcsingle: Markov chain Monte Carlo propagation

For further information simply call both submodule with added -h flag.

Documentation

All options are well documented and may be viewed by MSMPathfinder -h.

Citations

The underlying methods are based on the following article: - D. Nagel, A. Weber and G. Stock, MSMPathfinder: Identification of pathways in Markov state models, J. Chem. Theory Comput., 16, 7874 (2020); DOI: 10.1021/acs.jctc.0c00774

We kindly ask you to cite this article if you use this software package for published works.

Licensing

This project was created by moldyn-nagel.

Copyright (c) 2020-2021, Daniel Nagel All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Installation

Requirements

required: - BOOST >= 1.49 - cmake >= 2.8 - a recent C++ compiler (e.g. GNU g++ >= 4.9, must support C++11 standard)

Quick-Start

To quickly get a working binary

```bash

clone the repo

git clone https://github.com/moldyn/MSMPathfinder.git

create a build folder inside the code directory

cd MSMPathfinder mkdir build

change to the build directory and prepare make

if installition is not desired you can execute "cmake .." instead

cd build cmake .. -DCMAKEINSTALLPREFIX=/my/installation/path

then compile and install the package to /my/installation/path

(or any other path you chose above) by invoking

make make install ```

Owner

  • Name: Biomolecular Dynamics
  • Login: moldyn
  • Kind: organization
  • Location: Freiburg

Group of Prof. Dr. G. Stock, University of Freiburg

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Nagel"
  given-names: "Daniel"
  orcid: "https://orcid.org/0000-0002-2863-2646"
- family-names: "Weber"
  given-names: "Anna"
- family-names: "Stock"
  given-names: "Gerhard"
  orcid: "https://orcid.org/0000-0002-3302-3044"
title: "MSMPathfinder"
version: 0.9.0
url: "https://github.com/moldyn/MSMPathfinder"
preferred-citation:
  type: article
  authors:
  - family-names: "Nagel"
    given-names: "Daniel"
    orcid: "https://orcid.org/0000-0002-2863-2646"
  - family-names: "Weber"
    given-names: "Anna"
  - family-names: "Stock"
    given-names: "Gerhard"
    orcid: "https://orcid.org/0000-0002-3302-3044"
  doi: "10.1021/acs.jctc.0c00774"
  journal: "Journal of Chemical Theory and Computation"
  month: 11
  start: 7874
  end: 7882
  title: "MSMPathfinder: Identification of pathways in Markov state models"
  issue: 12
  volume: 16
  year: 2020

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 15
  • Total Committers: 2
  • Avg Commits per committer: 7.5
  • Development Distribution Score (DDS): 0.467
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
braniii d****l@p****m 8
moldyn-nagel d****l@p****e 7
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels