Adding pre-commit (#45)

* pre-commit

* black

* black

* black update

* black

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+fail_fast: false
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    -   id: check-yaml
+        exclude: "docs"
+    -   id: end-of-file-fixer
+        exclude: "docs"
+    -   id: trailing-whitespace
+        exclude: "docs"
+
+-   repo: https://github.com/psf/black
+    rev: 23.10.0
+    hooks:
+    -   id: black
+        args: [ '--config', 'pyproject.toml' ]
+        verbose: true

Dockerfile

@@ -17,4 +17,4 @@ RUN cd pomdp-py/ && pip install -e.
 WORKDIR /app/pomdp-py
 
 # activate 'pomdp' environment by default
-RUN echo "conda activate pomdp" >> ~/.bashrc
+RUN echo "conda activate pomdp" >> ~/.bashrc

LICENSE

@@ -6,4 +6,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -4,6 +4,3 @@ clean:
 .PHONY: build
 build:
 	python setup.py build_ext --inplace
-
-
-

pomdp_py/__init__.py

@@ -11,16 +11,28 @@
 from pomdp_py.representations.distribution.gaussian import Gaussian
 from pomdp_py.representations.belief.histogram import update_histogram_belief
 from pomdp_py.representations.belief.particles import update_particles_belief
-from pomdp_py.utils.interfaces.conversion import to_pomdp_file, to_pomdpx_file, AlphaVectorPolicy, PolicyGraph
+from pomdp_py.utils.interfaces.conversion import (
+    to_pomdp_file,
+    to_pomdpx_file,
+    AlphaVectorPolicy,
+    PolicyGraph,
+)
 from pomdp_py.utils.interfaces.solvers import vi_pruning, sarsop
 
 # Algorithms
 from pomdp_py.algorithms.value_iteration import ValueIteration  # Cython compiled
 from pomdp_py.algorithms.value_function import value, qvalue, belief_update
 from pomdp_py.algorithms.pomcp import POMCP
 from pomdp_py.algorithms.po_rollout import PORollout
-from pomdp_py.algorithms.po_uct import POUCT, QNode, VNode, RootVNode,\
-    RolloutPolicy, RandomRollout, ActionPrior
+from pomdp_py.algorithms.po_uct import (
+    POUCT,
+    QNode,
+    VNode,
+    RootVNode,
+    RolloutPolicy,
+    RandomRollout,
+    ActionPrior,
+)
 from pomdp_py.algorithms.bsp.blqr import BLQR
 
 # Templates & Utilities

pomdp_py/__main__.py

@@ -1,42 +1,47 @@
 import argparse
 
-available_problems = [
-    'tiger',
-    'rocksample',
-    'mos',
-    'tag',
-    'load_unload'
-]
+available_problems = ["tiger", "rocksample", "mos", "tag", "load_unload"]
+
 
 def parse_args():
     parser = argparse.ArgumentParser(description="pomdp_py CLI")
-    parser.add_argument("-r", "--run", type=str,
-                        help="run a pomdp under pomdp_py.problems."
-                        "Available options: {}".format(available_problems))
+    parser.add_argument(
+        "-r",
+        "--run",
+        type=str,
+        help="run a pomdp under pomdp_py.problems."
+        "Available options: {}".format(available_problems),
+    )
     args = parser.parse_args()
     return parser, args
 
+
 if __name__ == "__main__":
     parser, args = parse_args()
     if args.run:
         if args.run.lower() == "tiger":
             from pomdp_py.problems.tiger.tiger_problem import main
+
             main()
 
         elif args.run.lower() == "rocksample":
             from pomdp_py.problems.rocksample.rocksample_problem import main
+
             main()
 
         elif args.run.lower() == "mos":
             from pomdp_py.problems.multi_object_search.problem import unittest
+
             unittest()
 
         elif args.run.lower() == "tag":
             from pomdp_py.problems.tag.problem import main
+
             main()
 
         elif args.run.lower() == "load_unload":
             from pomdp_py.problems.load_unload.load_unload import main
+
             main()
 
         else: