Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vlad0x00 committed Sep 9, 2022
1 parent e3fd034 commit 07d81f5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ <h2><a class="anchor" id="autotoc_md2"></a>
</li>
<li>Running Python code:<ul>
<li>The Python used to import btllib <em>must</em> be the same as the one used to compile the library. Specifically, btllib uses <code>python3-config</code> to determine the flags used for compilation. Running <code>python3-config --exec-prefix</code> will give the path to the Python installation that needs to be used. The <code>python3</code> executable can be found at <code>$(python3-config --exec-prefix)/bin/python3</code>.</li>
<li>The wrappers correspond one-to-one with C++ code so any functions and classes can be used under the same name. The only exception are nested classes which are prefixed with outer class name (e.g. <code><a class="el" href="structbtllib_1_1SeqReader_1_1Flag.html">btllib::SeqReader::Flag</a></code> in C++ versus <code>btllib.SeqReaderFlag</code> in Python).</li>
<li>The wrappers correspond one-to-one with C++ code so any functions and classes can be used under the same name. The only exceptions are nested classes which are prefixed with outer class name (e.g. <code><a class="el" href="structbtllib_1_1SeqReader_1_1Flag.html">btllib::SeqReader::Flag</a></code> in C++ versus <code>btllib.SeqReaderFlag</code> in Python), and (Kmer)CountingBloomFilter which provides <code>CountingBloomFilter8</code>, <code>CountingBloomFilter16</code>, <code>CountingBloomFilter32</code>, <code>KmerCountingBloomFilter8</code>, <code>KmerCountingBloomFilter16</code>, <code>CountingBloomFilter32</code> with counters 8, 16, and 32 bits wide.</li>
<li>If you compiled btllib from source code and didn't install the Python wrappers, you can use <code>PYTHONPATH</code> environment variable or <code>sys.path.append()</code> in your Python code to include <code>$PREFIX/lib/btllib/python/btllib</code> directory to make btllib available to the interpreter.</li>
<li>Include the library with <code>import btllib</code></li>
</ul>
Expand Down

0 comments on commit 07d81f5

Please sign in to comment.