Merge pull request #10 from KnowWhereGraph/develop

Add instructions for running through docker

Author: ckfisher

README.md

@@ -15,18 +15,18 @@ This breaks the reliance on the need for the graph database to support s2 indexi
 
 ### Docker
 
-Docker should be used to generate the s2 coverings, which can be done with
+Docker should be used to generate the s2 coverings, which can be done by running the following from the root folder.
 
 ```bash
-docker compose up -d
-docker exec -it s2 bash
-python3 src/s2.py --level <s2_level>
+git clone https://github.com/KnowWhereGraph/s2-coverings.git
+cd s2-coverings
+docker run -v ./:/s2 ghcr.io/knowwheregraph/s2-coverings:main python3 src/s2.py --level <level>
 ```
 
 Cell integration can be disabled by adding the `--ni` flag to the command,
 
 ```bash
-python3 src/s2.py --level <s2_level> --ni
+docker run -v ./:/s2 ghcr.io/knowwheregraph/s2-coverings:main python3 src/s2.py --level <level> --ni
 ```
 
 A complete list of options can be found by running
@@ -48,6 +48,18 @@ Due to the steps involved with installing the s2 libray bindings and different a
 
 ## Development
 
+### Running Locally With Docker
+
+During development, you'll need a way to run the local codebase with your changes. To do this run the following, 
+
+```bash
+docker compose up -d
+docker exec -it s2 bash
+python3 src/s2.py --level <s2_level>
+```
+
+The source code in the container will stay up to date with the local filesystem, so there's no need to rebuild the image after each code change.
+
 ### Linting
 
 This repository adheres to the Black tool's default settings. It also makes use of isort for import sorting.  Run these before each pull request. 

src/lib/geometric_feature.py

@@ -270,7 +270,6 @@ def filling(
 
 
 def yield_geometric_features(path: Path) -> Generator[GeometricFeature, None, None]:
-    print("====")
     if os.path.isfile(path):
         graph = Graph()
         with open(path, "r") as read_stream:

src/s2.py

@@ -31,7 +31,6 @@ def write_to_rdf(cell_id_int: int, out_path: str, rdf_format: str) -> None:
     graph = graphify(cell_id)
     if graph:
         for pfx in namespace_prefix:
-            print(pfx)
             graph.bind(pfx, namespace_prefix[pfx])
         file_extensions = {
             "ttl": ".ttl",
@@ -176,7 +175,6 @@ def get_vertex_polygon(cell: S2Cell) -> Polygon:
         id_as_integer = (
             current_id.id()
         )  # note that current_id is an instance of S2CellId
-        print(id_as_integer)
         cell_id_integers.append(id_as_integer)
         current_id = current_id.next()
         if current_id == ending_id:
@@ -195,5 +193,4 @@ def get_vertex_polygon(cell: S2Cell) -> Polygon:
 
     # Handle integration
     if not args.ni:
-        print("ni not present")
         Integrator(args.compressed)