Skip to content

Commit 11dce85

Browse files
author
Gerry Manoim
committed
DOC: Add install instructions to doc
1 parent a56eb4c commit 11dce85

3 files changed

Lines changed: 59 additions & 1 deletion

File tree

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ To install for development:
5353
Otherwise, ``pip install libpy``, making sure ``CC`` and ``CXX`` environment variables are set to the the right compiler.
5454

5555

56-
tests
56+
Tests
5757
-----
5858

5959
To run the unit tests, invoke:

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Welcome to libpy's documentation!
66
:caption: Contents:
77

88
tutorial
9+
install
910
appendix
1011

1112

docs/source/install.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
Setup
2+
=====
3+
4+
Requirements
5+
------------
6+
7+
lipy supports:
8+
9+
- macOS/Linux
10+
- Python >=3.5
11+
12+
lipy requires:
13+
14+
- gcc>=8 or clang>=10
15+
- numpy>=1.11.3
16+
17+
libpy also depends on:
18+
19+
- pcre
20+
- google sparsehash
21+
22+
To install these dependencies:
23+
24+
ubuntu
25+
~~~~~~
26+
27+
.. code-block:: bash
28+
29+
$ sudo apt install libpcre2-dev libsparsehash-dev
30+
31+
macOS
32+
~~~~~
33+
34+
.. code-block:: bash
35+
36+
$ brew install pcre2 google-sparsehash
37+
38+
Install
39+
-------
40+
41+
To install for development:
42+
43+
.. code-block:: bash
44+
45+
$ make
46+
47+
Otherwise, ``pip install libpy``, making sure ``CC`` and ``CXX`` environment variables are set to the the right compiler.
48+
49+
50+
Tests
51+
-----
52+
53+
To run the unit tests, invoke:
54+
55+
.. code-block:: bash
56+
57+
$ make test

0 commit comments

Comments
 (0)