-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
github-actions
committed
Nov 15, 2024
1 parent
524a921
commit 9bf1736
Showing
33 changed files
with
352 additions
and
8 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| .. _helanal: | ||
|
|
||
| ************************************************ | ||
| helanal | ||
| ************************************************ | ||
|
|
||
| | 🖋️ **Authors**: `helanal authors`_ | ||
| | 🏠 **Project home:** https://github.com/MDAnalysis/helanal/ | ||
| | 📖 **Documentation:** https://helanal.readthedocs.io | ||
| | ⚖️ **License:** GPL-2.0-or-later | ||
| | 🔑 **Keywords:** protein, structure, helix | ||
| | 🚀 **Development status:** Production/Stable | ||
| | 📜 **Changelog:** https://github.com/MDAnalysis/helanal/blob/main/CHANGELOG.md | ||
| | 📑 **Publications:** | ||
| | * https://doi.org/10.1002/bip.1967.360050708 | ||
| | * https://doi.org/10.1080/07391102.2000.10506570 | ||
| | 🧪 **Tests (latest):** |helanal_latest| | ||
| | 🧪 **Tests (develop):** |helanal_develop| | ||
| | **Description:** | ||
| | *helanal contains code to analyse protein helicies based on their Cα atoms, quantifying structural features such as local bending angles and global axes.* | ||
|
|
||
|
|
||
| Installation instructions | ||
| ========================= | ||
|
|
||
| The latest version of helanal can be installed using the following: | ||
|
|
||
| .. code-block:: bash | ||
| pip install helanal | ||
| The source code of helanal can be installed using the following: | ||
|
|
||
| .. code-block:: bash | ||
| pip install git+https://github.com/MDAnalysis/helanal@main | ||
| .. _`helanal authors`: | ||
| https://github.com/MDAnalysis/helanal/blob/main/AUTHORS.md | ||
|
|
||
| .. |helanal_latest| image:: https://img.shields.io/badge/latest-passed-green.svg | ||
| :alt: helanal develop CI status | ||
| :target: https://github.com/MDAnalysis/MDAKits/actions | ||
|
|
||
| .. |helanal_develop| image:: https://img.shields.io/badge/develop-passed-green.svg | ||
| :alt: helanal develop CI status | ||
| :target: https://github.com/MDAnalysis/MDAKits/actions | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,249 @@ | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <head> | ||
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/all.min.css" integrity="sha512-iBBXm8fW90+nuLcSKlbmrPcLa0OT92xO1BIsZ+ywDWZCvqsWgccV3gFoRBv0z+8dLJgyAHIhR35VZc2oM/gI1w==" crossorigin="anonymous" referrerpolicy="no-referrer" /> | ||
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/academicons/1.9.1/css/academicons.min.css" integrity="sha512-b1ASx0WHgVFL5ZQhTgiPWX+68KjS38Jk87jg7pe+qC7q9YkEtFq0z7xCglv7qGIs/68d3mAp+StfC8WKC5SSAg==" crossorigin="anonymous" referrerpolicy="no-referrer" /> | ||
| <link rel="shortcut icon" href="_static/mdakits-logo.ico"> | ||
| </head> | ||
|
|
||
|
|
||
|
|
||
| <!DOCTYPE html> | ||
| <html class="writer-html5" lang="en" data-content_root="./"> | ||
| <head> | ||
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
|
|
||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>helanal — MDAKits Registry documentation</title> | ||
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" /> | ||
| <link rel="stylesheet" type="text/css" href="_static/site.css" /> | ||
| <link rel="stylesheet" type="text/css" href="https://cdn.datatables.net/1.13.6/css/jquery.dataTables.min.css" /> | ||
|
|
||
|
|
||
| <link rel="shortcut icon" href="_static/mdakits-logo.ico"/> | ||
| <script src="_static/jquery.js?v=5d32c60e"></script> | ||
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> | ||
| <script src="_static/documentation_options.js?v=5929fcd5"></script> | ||
| <script src="_static/doctools.js?v=9a2dae69"></script> | ||
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> | ||
| <script src="https://cdn.datatables.net/1.13.6/js/jquery.dataTables.min.js"></script> | ||
| <script src="_static/main.js?v=71e46913"></script> | ||
| <script src="_static/js/versions.js"></script> | ||
| <script src="_static/js/theme.js"></script> | ||
| <link rel="author" title="About these documents" href="about.html" /> | ||
| <link rel="index" title="Index" href="genindex.html" /> | ||
| <link rel="search" title="Search" href="search.html" /> | ||
| <link rel="next" title="mda-tui" href="mda-tui.html" /> | ||
| <link rel="prev" title="zarrtraj" href="zarrtraj.html" /> | ||
| </head> | ||
|
|
||
| <body class="wy-body-for-nav"> | ||
| <div class="wy-grid-for-nav"> | ||
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> | ||
| <div class="wy-side-scroll"> | ||
| <div class="wy-side-nav-search" > | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <a href="index.html"> | ||
|
|
||
| <img src="_static/mdakits-logo-1563x1563.png" class="logo" alt="Logo"/> | ||
| </a> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <div role="search"> | ||
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> | ||
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> | ||
| <input type="hidden" name="check_keywords" value="yes" /> | ||
| <input type="hidden" name="area" value="default" /> | ||
| </form> | ||
| </div> | ||
|
|
||
| </div> | ||
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> | ||
|
|
||
| <p class="caption" role="heading"><span class="caption-text">MDAKit Registry</span></p> | ||
| <ul class="current"> | ||
| <li class="toctree-l1 current"><a class="reference internal" href="mdakits.html">Registry of MDAnalysis Toolkits (MDAKits)</a><ul class="current"> | ||
| <li class="toctree-l2"><a class="reference internal" href="lipidorderkit.html">lipidorderkit</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="waterdynamics.html">waterdynamics</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="transport-analysis.html">transport-analysis</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="MDANCE.html">MDANCE</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="MDonatello.html">MDonatello</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="mdaencore.html">mdaencore</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="membrane-curvature.html">membrane-curvature</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="maicos.html">maicos</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="mdachecker.html">mdachecker</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="pytim.html">pytim</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="mdacli.html">mdacli</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="ProLIF.html">ProLIF</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="mdakit-sasa.html">mdakit-sasa</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="solvation-analysis.html">solvation-analysis</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="PathSimAnalysis.html">PathSimAnalysis</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="OpenMMDL.html">OpenMMDL</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="spyrmsdkit.html">spyrmsdkit</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="lipyds.html">lipyds</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="propkatraj.html">propkatraj</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="mdahole2.html">mdahole2</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="zarrtraj.html">zarrtraj</a></li> | ||
| <li class="toctree-l2 current"><a class="current reference internal" href="#">helanal</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="#installation-instructions">Installation instructions</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="mda-tui.html">mda-tui</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="domhmm.html">domhmm</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="openmm-mdanalysis-reporter.html">openmm-mdanalysis-reporter</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">About</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="about.html">About MDAKits</a></li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">Resources for MDAKit Authors</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="makingakit.html">Making an MDAKit</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="addingakit.html">Adding an MDAKit to the Registry</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="maintainingakit.html">Maintaining an MDAKit</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li> | ||
| </ul> | ||
| <p class="caption" role="heading"><span class="caption-text">Other Resources</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="reviewersguide.html">Guide for reviewers</a></li> | ||
| </ul> | ||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| </nav> | ||
|
|
||
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > | ||
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| <a href="index.html">MDAKits Registry</a> | ||
| </nav> | ||
|
|
||
| <div class="wy-nav-content"> | ||
| <div class="rst-content"> | ||
| <div role="navigation" aria-label="Page navigation"> | ||
| <ul class="wy-breadcrumbs"> | ||
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> | ||
| <li class="breadcrumb-item"><a href="mdakits.html">Registry of MDAnalysis Toolkits (MDAKits)</a></li> | ||
| <li class="breadcrumb-item active">helanal</li> | ||
| <li class="wy-breadcrumbs-aside"> | ||
| <a href="_sources/helanal.rst.txt" rel="nofollow"> View page source</a> | ||
| </li> | ||
| </ul> | ||
| <hr/> | ||
| </div> | ||
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
| <div itemprop="articleBody"> | ||
|
|
||
| <section id="helanal"> | ||
| <span id="id1"></span><h1>helanal<a class="headerlink" href="#helanal" title="Link to this heading"></a></h1> | ||
| <div class="line-block"> | ||
| <div class="line">🖋️ <strong>Authors</strong>: <a class="reference external" href="https://github.com/MDAnalysis/helanal/blob/main/AUTHORS.md">helanal authors</a></div> | ||
| <div class="line">🏠 <strong>Project home:</strong> <a class="reference external" href="https://github.com/MDAnalysis/helanal/">https://github.com/MDAnalysis/helanal/</a></div> | ||
| <div class="line">📖 <strong>Documentation:</strong> <a class="reference external" href="https://helanal.readthedocs.io">https://helanal.readthedocs.io</a></div> | ||
| <div class="line">⚖️ <strong>License:</strong> GPL-2.0-or-later</div> | ||
| <div class="line">🔑 <strong>Keywords:</strong> protein, structure, helix</div> | ||
| <div class="line">🚀 <strong>Development status:</strong> Production/Stable</div> | ||
| <div class="line">📜 <strong>Changelog:</strong> <a class="reference external" href="https://github.com/MDAnalysis/helanal/blob/main/CHANGELOG.md">https://github.com/MDAnalysis/helanal/blob/main/CHANGELOG.md</a></div> | ||
| <div class="line">📑 <strong>Publications:</strong></div> | ||
| <div class="line-block"> | ||
| <div class="line">* <a class="reference external" href="https://doi.org/10.1002/bip.1967.360050708">https://doi.org/10.1002/bip.1967.360050708</a></div> | ||
| <div class="line">* <a class="reference external" href="https://doi.org/10.1080/07391102.2000.10506570">https://doi.org/10.1080/07391102.2000.10506570</a></div> | ||
| </div> | ||
| <div class="line">🧪 <strong>Tests (latest):</strong> <a class="reference external" href="https://github.com/MDAnalysis/MDAKits/actions"><img alt="helanal develop CI status" src="https://img.shields.io/badge/latest-passed-green.svg" /></a></div> | ||
| <div class="line">🧪 <strong>Tests (develop):</strong> <a class="reference external" href="https://github.com/MDAnalysis/MDAKits/actions"><img alt="helanal develop CI status" src="https://img.shields.io/badge/develop-passed-green.svg" /></a></div> | ||
| <div class="line"><strong>Description:</strong></div> | ||
| <div class="line"><em>helanal contains code to analyse protein helicies based on their Cα atoms, quantifying structural features such as local bending angles and global axes.</em></div> | ||
| </div> | ||
| <section id="installation-instructions"> | ||
| <h2>Installation instructions<a class="headerlink" href="#installation-instructions" title="Link to this heading"></a></h2> | ||
| <p>The latest version of helanal can be installed using the following:</p> | ||
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>helanal | ||
| </pre></div> | ||
| </div> | ||
| <p>The source code of helanal can be installed using the following:</p> | ||
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com/MDAnalysis/helanal@main | ||
| </pre></div> | ||
| </div> | ||
| </section> | ||
| </section> | ||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> | ||
| <a href="zarrtraj.html" class="btn btn-neutral float-left" title="zarrtraj" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | ||
| <a href="mda-tui.html" class="btn btn-neutral float-right" title="mda-tui" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | ||
| </div> | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <p>© Copyright 2022-2024, .</p> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <div class="footer"><p>Please see | ||
| our <a href="https://www.mdanalysis.org/pages/privacy/">Privacy Policy</a> | ||
| to learn how <a href="https://www.mdanalysis.org">MDAnalysis</a> collects data.</p> | ||
| <script data-goatcounter="https://mdanalysis.goatcounter.com/count" | ||
| async src="//gc.zgo.at/count.js"></script> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
| </footer> | ||
| </div> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| <script> | ||
| var versions_json_url = '' | ||
| </script> | ||
|
|
||
| <div class="rst-versions" data-toggle="rst-versions" role="note" | ||
| aria-label="versions"> | ||
| <span class="rst-current-version" data-toggle="rst-current-version"> | ||
| <span class="fa fa-book"></span> | ||
|
|
||
| <span class="fa fa-caret-down"></span> | ||
| </span> | ||
|
|
||
| <div class="rst-other-versions"> | ||
| <dl id="versionselector"> | ||
| <dt>Other Versions</dt> | ||
| </dl> | ||
|
|
||
| </div> | ||
| </div><script> | ||
| jQuery(function () { | ||
| SphinxRtdTheme.Navigation.enable(true); | ||
| }); | ||
| </script> | ||
|
|
||
| </body> | ||
| </html> |
Oops, something went wrong.