Skip to content

Commit b10c5cc

Browse files
doc: include pip in README
1 parent 02da55b commit b10c5cc

File tree

3 files changed

+24
-23
lines changed

3 files changed

+24
-23
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,14 @@ some related projects are [here](https://github.com/libsemigroups).
3434

3535
# Installation
3636

37-
It is currently only possible to install `libsemigroups_pybind11` using
38-
conda or from its sources. We plan to add the option of installing with
39-
`pip` in the future.
37+
## Installing with pip
38+
39+
It's possible to install `libsemigroups_pybind11` using `pip` via one of:
40+
41+
pip install libsemigroups_pybind11
42+
pip3 install libsemigroups_pybind11
43+
python -m pip install libsemigroups_pybind11
44+
python3 -m pip install libsemigroups_pybind11
4045

4146
## Installing with conda
4247

@@ -76,7 +81,7 @@ Assuming that you have `libsemigroups` installed you can install
7681
To build `libsemigroups_pybind11` from a release archive:
7782

7883
curl -L -O https://github.com/libsemigroups/libsemigroups_pybind11/releases/latest/download/libsemigroups_pybind11-0.2.0.tar.gz
79-
tar -xf libsemigroups_pybind11-0.2.0.tar.gz
84+
tar -xf libsemigroups_pybind11-0.2.0.tar.gz
8085
rm -f libsemigroups_pybind11-0.2.0.tar.gz
8186
cd libsemigroups_pybind11-0.2.0
8287
pip install .
@@ -92,7 +97,7 @@ The following are required to be able to build the documentation:
9297
Assuming you already have `python3` install, on Mac OSX you can install
9398
all of the above by doing:
9499

95-
python3 -m pip3 install -r docs/requirements
100+
python3 -m pip3 install -r docs/requirements
96101

97102
Then it ought to be possible to just run `make doc` in the
98103
`libsemigroups` directory.

docs/source/index.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ What is ``libsemigroups``?
88
~~~~~~~~~~~~~~~~~~~~~~~~~~
99

1010
``libsemigroups`` is a C++14 library containing implementations of several
11-
algorithms for computing finite and finitely presented semigroups.
11+
algorithms for computing finite and finitely presented semigroups.
1212
Namely:
1313

1414
- the `Froidure-Pin algorithm`_ for computing finite semigroups
@@ -20,20 +20,20 @@ Namely:
2020
semigroups which act on sets.
2121

2222
``libsemigroups_pybind11`` is a python package exposing much (but not all) of
23-
the functionality of ``libsemigroups``.
23+
the functionality of ``libsemigroups``.
2424

2525
The development version of ``libsemigroups_pybind11`` is available on github_,
2626
and some related projects are here_.
2727

2828
.. _github: https://github.com/libsemigroups/libsemigroups_pybind11
29-
.. _here: https://github.com/libsemigroups
29+
.. _here: https://github.com/libsemigroups
3030

3131
.. _Froidure-Pin algorithm: https://www.irif.fr/~jep/PDF/Rio.pdf
3232
.. _Todd-Coxeter algorithm: https://en.wikipedia.org/wiki/Todd%E2%80%93Coxeter_algorithm
3333
.. _Knuth-Bendix algorithm: https://en.wikipedia.org/wiki/Knuth%E2%80%93Bendix_completion_algorithm
3434
.. _Schreier-Sims algorithm: https://en.wikipedia.org/wiki/Schreier%E2%80%93Sims_algorithm
3535
.. _Konieczny: https://link.springer.com/article/10.1007/BF02573672
36-
.. _Lallement-McFadden: https://www.sciencedirect.com/science/article/pii/S0747717108800570
36+
.. _Lallement-McFadden: https://www.sciencedirect.com/science/article/pii/S0747717108800570
3737

3838
How to use it
3939
~~~~~~~~~~~~~
@@ -42,7 +42,7 @@ See the installation instructions:
4242

4343
.. toctree::
4444
:maxdepth: 1
45-
45+
4646
install
4747
changelog
4848

@@ -67,5 +67,5 @@ See the installation instructions:
6767
.. toctree::
6868
:caption: Further info
6969
:maxdepth: 1
70-
70+
7171
authors

docs/source/install.rst

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@
99
Installation
1010
============
1111

12-
It is currently only possible to install ``libsemigroups_pybind11`` using conda
13-
or from its sources. We plan to add the option of installing with ``pip`` in
14-
the future.
15-
1612
Installing with pip
1713
-------------------
1814

@@ -28,7 +24,7 @@ Installing with conda
2824
---------------------
2925

3026
This installation method assumes that you have anaconda or miniconda installed.
31-
See the `getting started`_ and `miniconda download page`_ on the conda_
27+
See the `getting started`_ and `miniconda download page`_ on the conda_
3228
website.
3329

3430
.. _getting started: http://bit.ly/33B0Vfs
@@ -48,9 +44,9 @@ Install ``libsemigroups_pybind11``:
4844
::
4945

5046
conda install -c conda-forge libsemigroups_pybind11
51-
52-
.. warning::
53-
47+
48+
.. warning::
49+
5450
At present this does not work for Macs with M1 processors.
5551

5652

@@ -78,12 +74,12 @@ To build ``libsemigroups_pybind11`` from a release archive:
7874
.. parsed-literal::
7975
8076
curl -L -O https://github.com/libsemigroups/libsemigroups_pybind11/releases/latest/download/libsemigroups_pybind11-|libsemigroups-pybind11-version|.tar.gz
81-
tar -xf libsemigroups_pybind11-|libsemigroups-pybind11-version|.tar.gz
77+
tar -xf libsemigroups_pybind11-|libsemigroups-pybind11-version|.tar.gz
8278
rm -f libsemigroups_pybind11-|libsemigroups-pybind11-version|.tar.gz
8379
cd libsemigroups_pybind11-|libsemigroups-pybind11-version|
8480
pip install .
8581
86-
Building the documentation
82+
Building the documentation
8783
--------------------------
8884

8985
The following are required to be able to build the documentation:
@@ -97,10 +93,10 @@ the above by doing:
9793

9894
::
9995

100-
python3 -m pip3 install -r docs/requirements
96+
python3 -m pip3 install -r docs/requirements
10197

10298
Then it ought to be possible to just run ``make doc`` in the ``libsemigroups``
103-
directory.
99+
directory.
104100

105101
Issues
106102
------

0 commit comments

Comments
 (0)