Feature/pip install

README.md

@@ -36,7 +36,6 @@ where `<clone-dir>` is the directory where you cloned the `PyTeLo` repository.
 
 Install *Gurobi* with *gurobipy* for python3.
 
-
 Run
 ---
 
@@ -59,6 +58,17 @@ BibTeX:
 }
 ```
 
+Install as Package
+---
+After running `antlr4` above, from one directory level above `pytelo/`
+
+```bash
+pip install pytelo/
+```
+
+This will let other packages import pytelo functions without including pytelo in their directory structure or referencing the associated files by location.
+
+
 **NOTE:** At the moment the implementation only supports python2 and python3. However, you
 can generate lexers, parsers, listners, and visitors for other target languages,
 such as Java (default), C++, C#, Go, JavaScript, and Swift.

setup.py

@@ -0,0 +1,26 @@
+from setuptools import find_packages, setup
+
+DISTNAME = "PyTeLo"
+
+DESCRIPTION = "A Flexible and Efficient Temporal Logic Tool for Python"
+
+INSTALL_REQUIRES = ["antlr4-python3-runtime==4.13.0",
+                    "scipy",
+                    "gurobipy"]
+
+setup(
+    name=DISTNAME,
+    author="ERL Lehigh",
+    version="0.1.0",
+    description=DESCRIPTION,
+    url="https://github.com/erl-lehigh/PyTeLo",
+    python_requires=">=3.6, <3.11",
+    package_dir={"": "src"},
+    packages=find_packages("src"),
+    include_package_data=True,
+    install_requires=INSTALL_REQUIRES,
+    # extras_require=EXTRAS_REQUIRES,
+)
+
+# to install:
+# pip install .

src/pytelo/__init__.py

@@ -0,0 +1,5 @@
+from .stl import STLFormula, Trace, TraceBatch
+from .mtl import MTLFormula
+
+
+__version__ = "0.1.0"

src/pytelo/mtl/__init__.py

@@ -0,0 +1,5 @@
+from .mtlLexer import mtlLexer
+from .mtlParser import mtlParser
+from .mtl import MTLAbstractSyntaxTreeExtractor
+from .mtl import Operation, MTLFormula
+from .mtl import to_ast

mtl/mtl.py → src/pytelo/mtl/mtl.py

@@ -6,9 +6,9 @@
 
 from antlr4 import InputStream, CommonTokenStream
 
-from mtlLexer import mtlLexer
-from mtlParser import mtlParser
-from mtlVisitor import mtlVisitor
+from .mtlLexer import mtlLexer
+from .mtlParser import mtlParser
+from .mtlVisitor import mtlVisitor
 
 
 class Operation(object):

mtl/mtl2milp.py → src/pytelo/mtl/mtl2milp.py

@@ -6,7 +6,7 @@
 
 import gurobipy as grb
 
-from mtl import Operation, MTLFormula
+from .mtl import Operation, MTLFormula
 
 
 class mtl2milp(object):
@@ -146,4 +146,4 @@ def until(self, formula, z, t):
                                  + sum(z_children_left[:t+a+k+1]))
 
             self.model.addConstr(z >= z_conj)
-        self.model.addConstr(z <= sum(z_aux))
+        self.model.addConstr(z <= sum(z_aux))

src/pytelo/stl/__init__.py

@@ -0,0 +1,5 @@
+from .stlLexer import stlLexer
+from .stlParser import stlParser
+from .stl import STLAbstractSyntaxTreeExtractor
+from .stl import Operation, RelOperation, STLFormula, Trace, TraceBatch
+from .stl import to_ast

stl/agm.py → src/pytelo/stl/agm.py

@@ -9,8 +9,8 @@
 import numpy as np
 from antlr4 import InputStream, CommonTokenStream
 
-from stlLexer import stlLexer
-from stlParser import stlParser
+from .stlLexer import stlLexer
+from .stlParser import stlParser
 
 from stl import Operation, RelOperation, STLAbstractSyntaxTreeExtractor, Trace
 

stl/stl.py → src/pytelo/stl/stl.py

@@ -11,9 +11,9 @@
 from scipy.interpolate import interp1d
 from antlr4 import InputStream, CommonTokenStream
 
-from stlLexer import stlLexer
-from stlParser import stlParser
-from stlVisitor import stlVisitor
+from .stlLexer import stlLexer
+from .stlParser import stlParser
+from .stlVisitor import stlVisitor
 
 
 class Operation(object):

stl/stl2milp.py → src/pytelo/stl/stl2milp.py

@@ -7,7 +7,7 @@
 
 import gurobipy as grb
 
-from stl import Operation, RelOperation, STLFormula
+from .stl import Operation, RelOperation, STLFormula
 
 
 class stl2milp(object):
@@ -86,7 +86,6 @@ def add_state(self, state, t):
             name='{}_{}'.format(state, t)
             v = self.model.addVar(vtype=vtype, lb=low, ub=high, name=name)
             self.variables[state][t] = v
-            print 'Added state:', state, 'time:', t
             self.model.update()
         return self.variables[state][t]