Skip to content

Commit a5e71cc

Browse files
committed
updating docs
1 parent cd0fd15 commit a5e71cc

File tree

3 files changed

+11
-3
lines changed

3 files changed

+11
-3
lines changed

README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,14 @@ Requirements:
8787
- Pandas
8888
- Matplotlib
8989
- Seaborn
90+
- Multiprocess
9091

9192
- C++ compiler (g++ >= v4.8)
9293

9394
.. code:: bash
9495
9596
# To install dependencies
96-
pip install cython numpy scipy pandas matplotlib seaborn
97+
pip install cython numpy scipy pandas matplotlib seaborn multiprocess
9798
9899
# Clone HyDe repository from GitHub
99100
git clone https://github.com/pblischak/HyDe.git

docs/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ If you only have a few hypotheses that you want to test, then you can also pass
4949
a triples file to ``run_hyde.py`` and it will only test those hypotheses rather than
5050
testing everything.
5151

52+
Multithreaded versions of these scripts are also available (``run_hyde_mp.py``,
53+
``individual_hyde_mp.py``, and ``bootstrap_hyde_mp.py``).
54+
Make sure you have the ``multiprocess`` module installed before you use them:
55+
``pip install multiprocess``.
56+
5257
Getting help
5358
------------
5459

docs/installation.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,15 @@ Required Python packages
2525
------------------------
2626

2727
With Miniconda installed, we can use ``pip`` or ``conda`` to install all of the Python
28-
modules that HyDe requires (Cython, Numpy, Pandas, Scipy, Matplotlib, and Seaborn).
28+
modules that HyDe requires (Cython, Numpy, Pandas, Scipy, Matplotlib, Seaborn, and Multiprocess).
2929

3030
.. code:: bash
3131
3232
# Install packages with conda or pip command
3333
conda install cython numpy pandas scipy matplotlib seaborn
34-
# pip install cython numpy pandas scipy matplotlib seaborn
34+
35+
# use pip to install multiprocess
36+
pip install multiprocess
3537
3638
Installing HyDe
3739
---------------

0 commit comments

Comments
 (0)