Add cli to python api (#50)

* Add cli to python api with entry point. Fixes #45

data/three_errors.dem

@@ -0,0 +1,3 @@
+error(0.1) D0 L0
+error(0.1) D0 D1 L1
+error(0.1) D1 L2

data/three_errors.dets

@@ -0,0 +1,4 @@
+shot
+shot D0
+shot D1
+shot D0 D1

docs/developer_documentation.md

@@ -151,16 +151,16 @@ pip install -e .
 First install the sphinx requirements:
 
 ```bash
-pip install -r docs/requirements.txt
+pip install -r docs/sphinx_docs/requirements.txt
 ```
 
 You will also need to install the latest version of pymatching, and you may also need to [install pandoc](https://pandoc.org/installing.html).
 
 Then, to build the html sphinx docs, run:
 ```bash
-cd docs
+cd docs/sphinx_docs
 make html
 ```
 
-and view `doc/build/html/index.html` in a browser.
+and view `docs/sphinx_docs/build/html/index.html` in a browser.
 

docs/sphinx_docs/source/api.rst

@@ -3,7 +3,17 @@ Python API Documentation
 
 
 Matching
---------------------
+--------
 .. automodule:: pymatching.matching
     :members:
-    :special-members: __init__
+    :special-members: __init__
+
+Command line interface
+----------------------
+.. automethod:: pymatching.cli
+
+Random number generator
+-----------------------
+.. automethod:: pymatching.set_seed
+.. automethod:: pymatching.randomize
+.. automethod:: pymatching.rand_float

setup.py

@@ -149,6 +149,9 @@ def build_extension(self, ext):
     cmdclass={"build_ext": CMakeBuild},
     zip_safe=False,
     extras_require={"test": ["pytest>=6.0"]},
+    entry_points={
+        'console_scripts': ['pymatching=pymatching._cli_argv:cli_argv'],
+    },
     python_requires=">=3.6",
     install_requires=['scipy', 'numpy', 'networkx', 'retworkx>=0.11.0', 'matplotlib']
 )

src/pymatching/__init__.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 from pymatching._cpp_pymatching import (randomize, set_seed, rand_float)  # noqa
+from pymatching._cpp_pymatching import main as cli  # noqa
 from pymatching.matching import Matching  # noqa
 
 randomize()  # Set random seed using std::random_device

src/pymatching/_cli_argv.py

@@ -0,0 +1,7 @@
+import sys
+
+import pymatching
+
+
+def cli_argv():
+    pymatching.cli(command_line_args=sys.argv[1:])

src/pymatching/rand/rand_gen.pybind.cc

@@ -43,12 +43,14 @@ void pm_pybind::pybind_rand_gen_methods(py::module &m) {
     m.def("rand_float", &pm::rand_float, "from"_a, "to"_a, R"pbdoc(
         Generate a floating point number chosen uniformly at random
         over the interval between `from` and `to`
+
         Parameters
         ----------
         from: float
             Smallest float that can be drawn from the distribution
         to: float
             Largest float that can be drawn from the distribution
+
         Returns
         -------
         float

tests/cli_test.py

@@ -0,0 +1,51 @@
+import os
+import sys
+from contextlib import contextmanager
+
+import pymatching
+from pymatching import cli
+from pymatching._cli_argv import cli_argv
+
+from .config import DATA_DIR
+
+
+@contextmanager
+def three_errors_data():
+    out_fn = os.path.join(DATA_DIR, "three_errors_predictions.dets")
+    if os.path.isfile(out_fn):
+        os.remove(out_fn)
+    assert not os.path.exists(out_fn)
+    args = [
+        "predict",
+        "--dem", os.path.join(DATA_DIR, "three_errors.dem"),
+        "--in", os.path.join(DATA_DIR, "three_errors.dets"),
+        "--in_format", "dets",
+        "--out", out_fn,
+        "--out_format", "dets",
+    ]
+    yield args
+    assert os.path.isfile(out_fn)
+    with open(out_fn) as f:
+        assert f.read() == """shot
+shot L0
+shot L2
+shot L1
+"""
+    os.remove(out_fn)
+
+
+def test_cli():
+    with three_errors_data() as args:
+        cli(command_line_args=args)
+
+
+def test_protected_cli():
+    with three_errors_data() as args:
+        pymatching._cpp_pymatching.main(command_line_args=args)
+
+
+def test_cli_argv():
+    from unittest.mock import patch
+    with three_errors_data() as args:
+        with patch.object(sys, 'argv', ["cli"] + args):
+            cli_argv()

tests/config.py

@@ -0,0 +1,5 @@
+import pathlib
+import os
+
+THIS_DIR = pathlib.Path(__file__).parent.resolve()
+DATA_DIR = os.path.join(pathlib.Path(THIS_DIR).parent.absolute(), "data")

tests/matching/decode_test.py

@@ -21,7 +21,7 @@
 import pymatching
 from pymatching import Matching
 
-from .config import DATA_DIR
+from tests.config import DATA_DIR
 
 
 def repetition_code(n):

tests/matching/load_from_stim_test.py

@@ -17,7 +17,7 @@
 import pytest
 
 from pymatching.matching import Matching
-from .config import DATA_DIR
+from tests.config import DATA_DIR
 
 
 def test_load_from_stim_objects():