Simple-Track 2.0.0__tar.gz → 2.0.2__tar.gz

{simple_track-2.0.0 → simple_track-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Simple-Track
-Version: 2.0.0
+Version: 2.0.2
 Summary: Threshold-based object tracking algorithm for 2D data 
 Author-email: Adam Gainford <adam.gainford@reading.ac.uk>, Thorwald Stein <t.h.m.stein@reading.ac.uk>
 License-Expression: MPL-2.0
@@ -33,7 +33,13 @@ Features are tracked between consecutive frames of data by projecting feature fi
 
 # Installation
 
-Coming soon to PyPi and conda-forge
+Simple-Track can be installed using PyPi:
+
+```
+python3 -m pip install simple-track
+```
+
+Coming soon to conda-forge and uv
 
 # User Guide
 
@@ -56,7 +62,7 @@ Simple-Track can be run in two ways:
 * Simple-Track can be run from the command line with a config file as an additional argument:
 
 	```
-	run_simple_track my_config.yaml 
+	simpletrack my_config.yaml 
 	```
 
 * The `my_config.yaml` file contains the parameters for running Simple-Track. The necessary parameters for running Simple-Track from the command line are shown below:
@@ -197,6 +203,7 @@ OUTPUT:
   path: ./output
   experiment_name: Simple-Track Experiment # Name of experiment to add to output files 
   save_data: true # Whether to save data to output
+  skip_tracking: false # Whether to skip tracking and just output feature properties
 
 FEATURE:
   threshold: 1 # Threshold used for defining a feature
@@ -211,7 +218,6 @@ FLOW_SOLVER:
   apply_tukey_filtering: True # Apply a 2D Tukey window to each subdomain before phase cross-correlation
 
 TRACKING:
-  skip_tracking: false # Whether to skip tracking and just output feature properties
   overlap_nbhood: 5 # Radius of halo in pixels for orphan storms - big halo assumes storms may spawn "children" at a distance multiple pixels away
   overlap_threshold: 0.6 # Minimum fraction of overlap 
   retain_lifetime_on_split: True # If a child Feature splits from its parent feature, this determines whether the child Feature should carry over the lifetime from the parent or whether its lifetime should be set to 1

{simple_track-2.0.0 → simple_track-2.0.2}/README.md

@@ -11,7 +11,13 @@ Features are tracked between consecutive frames of data by projecting feature fi
 
 # Installation
 
-Coming soon to PyPi and conda-forge
+Simple-Track can be installed using PyPi:
+
+```
+python3 -m pip install simple-track
+```
+
+Coming soon to conda-forge and uv
 
 # User Guide
 
@@ -34,7 +40,7 @@ Simple-Track can be run in two ways:
 * Simple-Track can be run from the command line with a config file as an additional argument:
 
 	```
-	run_simple_track my_config.yaml 
+	simpletrack my_config.yaml 
 	```
 
 * The `my_config.yaml` file contains the parameters for running Simple-Track. The necessary parameters for running Simple-Track from the command line are shown below:
@@ -175,6 +181,7 @@ OUTPUT:
   path: ./output
   experiment_name: Simple-Track Experiment # Name of experiment to add to output files 
   save_data: true # Whether to save data to output
+  skip_tracking: false # Whether to skip tracking and just output feature properties
 
 FEATURE:
   threshold: 1 # Threshold used for defining a feature
@@ -189,7 +196,6 @@ FLOW_SOLVER:
   apply_tukey_filtering: True # Apply a 2D Tukey window to each subdomain before phase cross-correlation
 
 TRACKING:
-  skip_tracking: false # Whether to skip tracking and just output feature properties
   overlap_nbhood: 5 # Radius of halo in pixels for orphan storms - big halo assumes storms may spawn "children" at a distance multiple pixels away
   overlap_threshold: 0.6 # Minimum fraction of overlap 
   retain_lifetime_on_split: True # If a child Feature splits from its parent feature, this determines whether the child Feature should carry over the lifetime from the parent or whether its lifetime should be set to 1

{simple_track-2.0.0 → simple_track-2.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "Simple-Track"
-version = "2.0.0"
+version = "2.0.2"
 authors = [
   { name="Adam Gainford", email="adam.gainford@reading.ac.uk" },
   { name="Thorwald Stein", email="t.h.m.stein@reading.ac.uk"} 
@@ -29,7 +29,7 @@ dependencies = [
 ]
 
 [project.scripts]
-run_simple_track = "run_simple_track"
+simpletrack = "run_simple_track:run_tracking"
 
 [project.urls]
 Homepage = "https://github.com/ParaChute-UK/simple-track/"

{simple_track-2.0.0 → simple_track-2.0.2}/src/Simple_Track.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Simple-Track
-Version: 2.0.0
+Version: 2.0.2
 Summary: Threshold-based object tracking algorithm for 2D data 
 Author-email: Adam Gainford <adam.gainford@reading.ac.uk>, Thorwald Stein <t.h.m.stein@reading.ac.uk>
 License-Expression: MPL-2.0
@@ -33,7 +33,13 @@ Features are tracked between consecutive frames of data by projecting feature fi
 
 # Installation
 
-Coming soon to PyPi and conda-forge
+Simple-Track can be installed using PyPi:
+
+```
+python3 -m pip install simple-track
+```
+
+Coming soon to conda-forge and uv
 
 # User Guide
 
@@ -56,7 +62,7 @@ Simple-Track can be run in two ways:
 * Simple-Track can be run from the command line with a config file as an additional argument:
 
 	```
-	run_simple_track my_config.yaml 
+	simpletrack my_config.yaml 
 	```
 
 * The `my_config.yaml` file contains the parameters for running Simple-Track. The necessary parameters for running Simple-Track from the command line are shown below:
@@ -197,6 +203,7 @@ OUTPUT:
   path: ./output
   experiment_name: Simple-Track Experiment # Name of experiment to add to output files 
   save_data: true # Whether to save data to output
+  skip_tracking: false # Whether to skip tracking and just output feature properties
 
 FEATURE:
   threshold: 1 # Threshold used for defining a feature
@@ -211,7 +218,6 @@ FLOW_SOLVER:
   apply_tukey_filtering: True # Apply a 2D Tukey window to each subdomain before phase cross-correlation
 
 TRACKING:
-  skip_tracking: false # Whether to skip tracking and just output feature properties
   overlap_nbhood: 5 # Radius of halo in pixels for orphan storms - big halo assumes storms may spawn "children" at a distance multiple pixels away
   overlap_threshold: 0.6 # Minimum fraction of overlap 
   retain_lifetime_on_split: True # If a child Feature splits from its parent feature, this determines whether the child Feature should carry over the lifetime from the parent or whether its lifetime should be set to 1

{simple_track-2.0.0 → simple_track-2.0.2}/src/Simple_Track.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 LICENSE
 README.md
 pyproject.toml
+src/run_simple_track.py
 src/Simple_Track.egg-info/PKG-INFO
 src/Simple_Track.egg-info/SOURCES.txt
 src/Simple_Track.egg-info/dependency_links.txt
@@ -15,7 +16,6 @@ src/simpletrack/frame.py
 src/simpletrack/frame_output.py
 src/simpletrack/frame_tracker.py
 src/simpletrack/load.py
-src/simpletrack/run_simple_track.py
 src/simpletrack/track.py
 src/simpletrack/utils.py
 tests/test_feature.py

simple_track-2.0.2/src/Simple_Track.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+simpletrack = run_simple_track:run_tracking

simple_track-2.0.2/src/Simple_Track.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+run_simple_track
+simpletrack

{simple_track-2.0.0/src/simpletrack → simple_track-2.0.2/src}/run_simple_track.py

@@ -1,8 +1,9 @@
 import sys
 
-from track import Tracker
+from simpletrack import Tracker
 
-if __name__ == "__main__":
+
+def run_tracking():
     if len(sys.argv) < 2:
         raise Exception("Running SimpleTrack requires path to at least one config")
 
@@ -10,3 +11,7 @@ if __name__ == "__main__":
     for config_path in config_paths:
         # With None passed into run method, uses input path in config
         Tracker(config_path).run()
+
+
+if __name__ == "__main__":
+    run_tracking()

{simple_track-2.0.0 → simple_track-2.0.2}/src/simpletrack/track.py

@@ -45,6 +45,8 @@ class Tracker:
 
         if "INPUT" in self.config:
             self.file_type = self.config["INPUT"].get("file_type", None)
+        else:
+            self.file_type = None
 
         if "FLOW_SOLVER" in self.config:
             self.flow_solver = FlowSolver(**self.config["FLOW_SOLVER"])
@@ -53,16 +55,19 @@ class Tracker:
 
         if "TRACKING" in self.config:
             self.frame_tracker = FrameTracker(**self.config["TRACKING"])
-            self.skip_tracking = self.config["TRACKING"].get("skip_tracking", False)
         else:
             self.frame_tracker = FrameTracker()
-            self.skip_tracking = False
 
         if "OUTPUT" in self.config:
+            self.skip_tracking = self.config["TRACKING"].get("skip_tracking", False)
             output_path = self.config["OUTPUT"].get("path", "./output")
             expt_name = self.config["OUTPUT"].get(
                 "experiment_name", "Simple-Track Experiment"
             )
+        else:
+            self.skip_tracking = False
+            output_path = "./output"
+            expt_name = "Simple-Track Experiment"
 
         # Output only if flagged in config
         self.frame_output = None

simple_track-2.0.0/src/Simple_Track.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-run_simple_track = run_simple_track

simple_track-2.0.0/src/Simple_Track.egg-info/top_level.txt

@@ -1 +0,0 @@
-simpletrack