Skip to content

Commit 2b3c927

Browse files
committed
1 parent c342ca2 commit 2b3c927

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

_sources/contribute.rst.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,8 @@ When done, activate the environment::
173173

174174
This will install scikit-bio to the current conda environment. After this, you can use scikit-bio like a normal user (e.g., you can do ``import skbio`` in Python code). When you edit the code in the this directory, the changes will be immediately reflected as you use the software.
175175

176+
.. note:: If you run into OpenMP compile issues (or have other reasons to avoid OpenMP), you can avoid it by setting ``DISABLE_OPENMP=Y`` in the build environment.
177+
176178
5. Test the installation::
177179

178180
make test
@@ -466,4 +468,4 @@ Congratulations! Your code is now an integral part of scikit-bio, and will benef
466468
Benchmarks
467469
----------
468470

469-
Scikit-bio utilizes `ASV <https://github.com/airspeed-velocity/asv>`_ to run benchmarks on a selection of its functions. Benchmarks help the development team prevent performance regression, the unintentional loss of performance which may come from modified code. Scikit-bio's benchmarks are run against every release of scikit-bio, starting with version ``0.6.1``. We welcome the addition of new benchmarks or the expansion of existing benchmarks to further protect against performance regression. If you are interested in contributing to our benchmarking system please see our `benchmark repository <https://github.com/scikit-bio/scikit-bio-benchmarks>`_.
471+
Scikit-bio utilizes `ASV <https://github.com/airspeed-velocity/asv>`_ to run benchmarks on a selection of its functions. Benchmarks help the development team prevent performance regression, the unintentional loss of performance which may come from modified code. Scikit-bio's benchmarks are run against every release of scikit-bio, starting with version ``0.6.1``. We welcome the addition of new benchmarks or the expansion of existing benchmarks to further protect against performance regression. If you are interested in contributing to our benchmarking system please see our `benchmark repository <https://github.com/scikit-bio/scikit-bio-benchmarks>`_.

contribute.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -586,6 +586,10 @@ <h2>Set up a workspace<a class="headerlink" href="#set-up-a-workspace" title="Li
586586
</li>
587587
</ol>
588588
<p>This will install scikit-bio to the current conda environment. After this, you can use scikit-bio like a normal user (e.g., you can do <code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">skbio</span></code> in Python code). When you edit the code in the this directory, the changes will be immediately reflected as you use the software.</p>
589+
<div class="admonition note">
590+
<p class="admonition-title">Note</p>
591+
<p>If you run into OpenMP compile issues (or have other reasons to avoid OpenMP), you can avoid it by setting <code class="docutils literal notranslate"><span class="pre">DISABLE_OPENMP=Y</span></code> in the build environment.</p>
592+
</div>
589593
<ol class="arabic" start="5">
590594
<li><p>Test the installation:</p>
591595
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">test</span>

0 commit comments

Comments
 (0)