core-lens 0.1.dev184__tar.gz → 0.1.dev186__tar.gz

{core_lens-0.1.dev184 → core_lens-0.1.dev186}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: core-lens
-Version: 0.1.dev184
+Version: 0.1.dev186
 Summary: Query, analyse, and visualise CoreStack's microwatershed and Earth science data through a clean, composable Python API.
 Project-URL: Homepage, https://github.com/ApoorvaKashyap/core-lens
 Project-URL: Issues, https://github.com/ApoorvaKashyap/core-lens/issues

{core_lens-0.1.dev184 → core_lens-0.1.dev186}/SKILLS.md

@@ -57,7 +57,9 @@ aoi = AoI(DATA_ROOT, bbox=(76.0, 31.0, 78.0, 33.0))
 aoi = AoI(DATA_ROOT, mws_id="13_551")
 
 # Optional: Override default seasons (kharif, rabi, zaid)
-custom_seasons = SeasonConfig(kharif=("06-01", "10-15"), rabi=("10-16", "02-28"), zaid=("03-01", "05-31"))
+custom_seasons = SeasonConfig(
+    kharif=("06-01", "10-15"), rabi=("10-16", "02-28"), zaid=("03-01", "05-31")
+)
 aoi_custom = AoI(DATA_ROOT, tehsil="Pangi", seasons=custom_seasons)
 ```
 
@@ -78,6 +80,7 @@ spatial_filtered = mws_view.spatial_filter(bbox=(76.5, 31.5, 77.5, 32.5))
 # Temporal Filtering
 # Note: You can filter by exact years, a range of years, or predefined seasons.
 from core_lens.base.view import Season
+
 temporal_view = mws_view.between(year=(2020, 2022), season=Season.KHARIF)
 current_view = mws_view.between(season=Season.CURRENT)
 ```
@@ -98,9 +101,9 @@ annual_result = temporal_view.annual.materialise()
 
 ```python
 # To access underlying data structures:
-df = static_result.df()        # Polars DataFrame (Zero-copy)
-lazy_df = static_result.lazy() # Polars LazyFrame
-gdf = static_result.gdf()      # GeoPandas GeoDataFrame (Heavy!)
+df = static_result.df()  # Polars DataFrame (Zero-copy)
+lazy_df = static_result.lazy()  # Polars LazyFrame
+gdf = static_result.gdf()  # GeoPandas GeoDataFrame (Heavy!)
 ```
 
 ## 5. Computation and Data Manipulation (Result API)
@@ -145,30 +148,53 @@ result.stats.describe(columns=["ndvi", "rainfall"])
 
 # Correlation (pearson, spearman, kendall)
 from core_lens.base.namespaces.stats import CorrelateMethod
-result.stats.correlate(columns=["ndvi", "rainfall"], method=CorrelateMethod.PEARSON, across="entity")
+
+result.stats.correlate(
+    columns=["ndvi", "rainfall"], method=CorrelateMethod.PEARSON, across="entity"
+)
 
 # Hypothesis Testing (t-test, mann-whitney, wilcoxon, ks, chi-square)
 from core_lens.base.namespaces.stats import TestMethod
-result.stats.test(column="cropping_intensity", groups="temperature_zone", method=TestMethod.MANN_WHITNEY)
+
+result.stats.test(
+    column="cropping_intensity",
+    groups="temperature_zone",
+    method=TestMethod.MANN_WHITNEY,
+)
 
 # Change Detection (absolute, percentage, trend)
 from core_lens.base.namespaces.stats import ChangeMethod
-result.stats.change(column="tree_cover", from_period=2018, to_period=2023, method=ChangeMethod.PERCENTAGE)
+
+result.stats.change(
+    column="tree_cover",
+    from_period=2018,
+    to_period=2023,
+    method=ChangeMethod.PERCENTAGE,
+)
 
 # Anomaly Detection
 from core_lens.base.namespaces.stats import AnomalyTsMethod, AnomalyCrossMethod
+
 # Mode 1: Cross-sectional (zscore, iqr, percentile, threshold)
-result.stats.anomaly(column="ndvi", mode="cross_sectional", method=AnomalyCrossMethod.ZSCORE, baseline=(2010, 2020))
+result.stats.anomaly(
+    column="ndvi",
+    mode="cross_sectional",
+    method=AnomalyCrossMethod.ZSCORE,
+    baseline=(2010, 2020),
+)
 # Mode 2: Time-series (stl, cusum, mad)
-result.stats.anomaly(column="ndvi", mode="timeseries", method=AnomalyTsMethod.STL, baseline=(2010, 2018))
+result.stats.anomaly(
+    column="ndvi", mode="timeseries", method=AnomalyTsMethod.STL, baseline=(2010, 2018)
+)
 
 # Similarity Matching (euclidean, cosine, mahalanobis, manhattan)
 from core_lens.base.namespaces.stats import SimilarityMethod
+
 result.stats.similarity(
     target="13_551",
     columns={"rainfall": ("annual", {"year": 2018})},
     method=SimilarityMethod.EUCLIDEAN,
-    top_n=10
+    top_n=10,
 )
 ```
 
@@ -214,6 +240,7 @@ You can extend core-lens with custom entities by subclassing `BaseEntity`.
 ```python
 from core_lens.base import BaseEntity
 
+
 class CustomEntity(BaseEntity):
     @property
     def key_cols(self) -> list[str]:
@@ -231,6 +258,7 @@ class CustomEntity(BaseEntity):
     def annual_path(self) -> str | None:
         return "custom/annual.parquet"
 
+
 AoI.register(CustomEntity)
 ```
 

{core_lens-0.1.dev184 → core_lens-0.1.dev186}/src/core_lens/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.1.dev184'
-__version_tuple__ = version_tuple = (0, 1, 'dev184')
+__version__ = version = '0.1.dev186'
+__version_tuple__ = version_tuple = (0, 1, 'dev186')
 
 __commit_id__ = commit_id = None

core_lens-0.1.dev186/src/core_lens/entities/farms.py

@@ -0,0 +1,63 @@
+from core_lens.base import BaseEntity
+
+
+class FarmEntity(BaseEntity):
+    """Farms entity.
+
+    Backed by:
+    - Static: farms/static
+    - Annual: farms/annual
+    - SubAnnual: farms/sub_annual
+
+    All paths are relative to the AoI ``data_root``.
+    """
+
+    @property
+    def key_cols(self) -> list[str]:
+        """Get the property value.
+
+        Returns:
+            list[str]: The key columns for the entity.
+
+        """
+        return ["farm_id"]
+
+    @property
+    def geometry_col(self) -> str:
+        """Get the property value.
+
+        Returns:
+            str: The geometry column name.
+
+        """
+        return "geometry"
+
+    @property
+    def static_path(self) -> str:
+        """Get the property value.
+
+        Returns:
+            str: The relative path to the static data.
+
+        """
+        return "farms/static.parquet"
+
+    @property
+    def annual_path(self) -> str:
+        """Get the property value.
+
+        Returns:
+            str: The relative path to the annual data.
+
+        """
+        return "farms/annual.parquet"
+
+    @property
+    def sub_annual_path(self) -> str:
+        """Get the property value.
+
+        Returns:
+            str: The relative path to the monthly data.
+
+        """
+        return "farms/sub_annual.parquet"