Files
rdkit/Code/GraphMol/MolHash/docs/commandline.html
Greg Landrum 5dfd67a22a Add new mol hashing code (#2636)
* copy in, get building, add some basic tests

* complete the testing
Except for regiosiomers, which do not work

* regioisomers work now

* backup commit; things work

* remove last of NM macros from hashfunctions.cpp

* remove last of NM macros from hashfunctions.cpp

* remove dependency on the abstraction layer

* typo

* start using namespaces
clang-format

* switch to using enums for the HashFunctions and StripTypes

* Add initial python wrapper (and tests)

* move the new hashing code to the MolHash library

still may want to revise the naming of this

* Setup deprecation of the older hashing code

* better release notes text

* change in response to review
2019-09-24 07:55:21 -04:00

313 lines
8.2 KiB
HTML

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>molhash application &mdash; MolHash 1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/nm_style.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Installation" href="installation.html" />
<script src="_static/js/modernizr.min.js"></script>
</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" class="icon icon-home"> MolHash
<img src="_static/nextmove_logo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
1.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="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="main navigation">
<p class="caption"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">molhash application</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">MolHash</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>molhash application</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="molhash-application">
<h1>molhash application<a class="headerlink" href="#molhash-application" title="Permalink to this headline"></a></h1>
<p>The command-line application <strong class="command">molhash</strong> can be used to generate one of a number of molecular hashes.</p>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">molhash</span> <span class="pre">[options]</span> <span class="pre">&lt;infile&gt;</span> <span class="pre">[&lt;outfile&gt;]</span></code></li>
<li><code class="docutils literal notranslate"><span class="pre">molhash</span> <span class="pre">[options]</span> <span class="pre">-</span> <span class="pre">[&lt;outfile&gt;]</span></code> - read from standard input</li>
</ul>
<p>For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ echo &quot;c1ccccc1C(=O)Cl&quot; | molhash -mf -
C7H5ClO c1ccc(cc1)C(=O)Cl
</pre></div>
</div>
</div>
<div class="section" id="options">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">-a</span></kbd></td>
<td>Process all the molecule (and not just the single largest component)</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-s<var>a</var></span></kbd></td>
<td>Suppress atom stereo</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-s<var>b</var></span></kbd></td>
<td>Suppress bond stereo</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-s<var>h</var></span></kbd></td>
<td>Suppress explicit hydrogens</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-s<var>i</var></span></kbd></td>
<td>Suppress isotopes</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-s<var>m</var></span></kbd></td>
<td>Suppress atom maps</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-t</span></kbd></td>
<td>Store titles only</td></tr>
</tbody>
</table>
<p class="rubric">Hash Types</p>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">-g</span></kbd></td>
<td>anonymous graph [default]</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-e</span></kbd></td>
<td>element graph</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-s</span></kbd></td>
<td>canonical smiles</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-m</span></kbd></td>
<td>Murcko scaffold</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-m<var>f</var></span></kbd></td>
<td>molecular formula</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-m<var>e</var></span></kbd></td>
<td>mesomer</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-h<var>t</var></span></kbd></td>
<td>hetatom tautomer</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-h<var>p</var></span></kbd></td>
<td>hetatom protomer</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-r<var>p</var></span></kbd></td>
<td>redox-pair</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-r<var>i</var></span></kbd></td>
<td>regioisomer</td></tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="installation.html" class="btn btn-neutral" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2015-2019, NextMove Software.
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enableSticky();
});
</script>
</body>
</html>