SoilRunNutri 0.1.13__py3-none-any.whl

SoilRunNutri/__init__.py

@@ -0,0 +1,22 @@
+__version__ = "0.1.13"
+
+from .model import (nitrogen_loss, phosphorus_loss, potassium_loss)
+
+__all__ = ["nitrogen_loss","phosphorus_loss","potassium_loss",]
+
+# Function to load your separate input file
+def load_input_file(file_path="inputuser.txt"):
+    """
+    Load the default input file or any user-specified input file.
+    
+    Parameters:
+    file_path : str
+        Path to the input file (default is 'inputuser.txt')
+    
+    Returns:
+    data : str
+        Content of the input file
+    """
+    with open(file_path, "r") as f:
+        data = f.read()
+    return data

SoilRunNutri/model.py

@@ -0,0 +1,130 @@
+"""
+Nutrient loss estimation based on either:
+1. Soil loss
+2. Percentage runoff
+
+User must choose ONE input method.
+"""
+
+
+# =========================
+# NITROGEN
+# =========================
+
+def nitrogen_loss(value, mode):
+    """
+    Calculate Nitrogen loss.
+    """
+
+    if mode == "soil":
+
+        if 0 <= value < 5:
+            nitrogen_loss_value = 2.3647 * value
+        elif 5 <= value < 10:
+            nitrogen_loss_value = 1.2927 * value + 0.270
+        elif 10 <= value < 20:
+            nitrogen_loss_value = 0.7909 * value - 0.2909
+        else:
+            nitrogen_loss_value = 0.8012 * value + 1.1358
+
+        print(f"The nitrogen loss based on soil loss is {nitrogen_loss_value}")
+
+    elif mode == "runoff":
+
+        if 0 <= value < 10:
+            nitrogen_loss_value = 4.285 * value
+        elif 10 <= value < 20:
+            nitrogen_loss_value = 0.415 * value + 0.246
+        elif 20 <= value < 30:
+            nitrogen_loss_value = 0.0679 * value - 0.0175
+        else:
+            nitrogen_loss_value = 0.0662 * value + 0.0144
+
+        print(f"The nitrogen loss based on runoff is {nitrogen_loss_value}")
+
+    else:
+        raise ValueError("Mode must be 'soil' or 'runoff'")
+
+    return nitrogen_loss_value
+
+
+# =========================
+# PHOSPHORUS
+# =========================
+
+def phosphorus_loss(value, mode):
+    """
+    Calculate Phosphorus loss.
+    """
+
+    if mode == "soil":
+
+        if 0 <= value < 5:
+            phosphorus_loss_value = 0.2096 * value
+        elif 5 <= value < 10:
+            phosphorus_loss_value = 0.0853 * value - 0.0103
+        elif 10 <= value < 20:
+            phosphorus_loss_value = 0.1048 * value + 0.0291
+        else:
+            phosphorus_loss_value = 0.0622 * value + 0.0794
+
+        print(f"The phosphorus loss based on soil loss is {phosphorus_loss_value}")
+
+    elif mode == "runoff":
+
+        if 0 <= value < 10:
+            phosphorus_loss_value = 0.189 * value
+        elif 10 <= value < 20:
+            phosphorus_loss_value = 0.0478 * value + 0.018
+        elif 20 <= value < 30:
+            phosphorus_loss_value = 0.027 * value - 0.0066
+        else:
+            phosphorus_loss_value = 0.0262 * value + 0.0046
+
+        print(f"The phosphorus loss based on runoff is {phosphorus_loss_value}")
+
+    else:
+        raise ValueError("Mode must be 'soil' or 'runoff'")
+
+    return phosphorus_loss_value
+
+
+# =========================
+# POTASSIUM
+# =========================
+
+def potassium_loss(value, mode):
+    """
+    Calculate Potassium loss.
+    """
+
+    if mode == "soil":
+
+        if 0 <= value < 5:
+            potassium_loss_value = 3.1155 * value
+        elif 5 <= value < 10:
+            potassium_loss_value = 1.2188 * value + 0.2178
+        elif 10 <= value < 20:
+            potassium_loss_value = 1.0204 * value + 2.5149
+        else:
+            potassium_loss_value = 0.5914 * value + 0.4662
+
+        print(f"The potassium loss based on soil loss is {potassium_loss_value}")
+
+    elif mode == "runoff":
+
+        if 0 <= value < 10:
+            potassium_loss_value = 2.289 * value
+        elif 10 <= value < 20:
+            potassium_loss_value = 0.4252 * value - 0.1895
+        elif 20 <= value < 30:
+            potassium_loss_value = 0.4512 * value - 0.3018
+        else:
+            potassium_loss_value = 0.4361 * value + 0.262
+
+        print(f"The potassium loss based on runoff is {potassium_loss_value}")
+
+    else:
+        raise ValueError("Mode must be 'soil' or 'runoff'")
+
+    return potassium_loss_value

soilrunnutri-0.1.13.dist-info/METADATA

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: SoilRunNutri
+Version: 0.1.13
+Summary: A Python package to estimate nutrient loss based on soil erosion.
+Author: Soumya Pant, Dr. Sadikul Islam, Dr. Gopal Kumar, Dr. M. Madhu
+License: MIT
+Keywords: soil,nutrient-loss,nitrogen,phosphorus,potassium
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Erosion Induced Nutrient Loss
+
+**Version:** 0.1.13  
+**Python Required:** 3.7 or higher  
+**License:** MIT License  
+
+SoilRunoffNutri is a Python package designed to estimate **erosion-induced nutrient losses** using empirical **piecewise linear regression models** that link runoff, soil loss, and sediment-associated nutrient transport from agricultural land.
+
+**Soil loss** is defined as the amount of soil removed from the land surface by rainfall and surface runoff and is expressed as tonnes per hectare (t ha⁻¹). It indicates the severity of erosion and depletion of fertile topsoil.
+
+**Runoff percentage** represents the proportion of rainfall converted into surface runoff, calculated as runoff depth divided by rainfall depth multiplied by 100, and reflects the potential for erosion and nutrient transport.
+
+The package estimates erosion-induced losses of the following nutrients, expressed in kg ha⁻¹:
+
+- Nitrogen (N)  
+- Phosphorus (P)  
+- Potassium (K)  
+
+Erosion-induced nutrient loss refers to the quantity of plant nutrients removed from agricultural land due to soil erosion and surface runoff. Nutrients are transported either in dissolved form with runoff water or attached to eroded soil particles (sediments).
+
+These losses are computed using empirically derived relationships based on long-term experimental datasets generated by **ICAR – Indian Institute of Soil and Water Conservation (IISWC), Dehradun**, aggregated across multiple agro-ecological regions of India. The resulting models provide robust applicability across diverse climatic and physiographic conditions.
+
+## Piecewise Linear Regression Framework
+
+The nutrient loss estimation framework adopts a **piecewise linear regression approach**, wherein separate linear equations are applied to different ranges of soil loss or runoff rather than a single equation over the entire range. By using locally fitted equations, the model accommodates changes in erosion–nutrient coupling mechanisms such as threshold-driven soil detachment, transport limitation, and nutrient enrichment at higher erosion levels. This structure enhances model flexibility and improves prediction accuracy under varying erosion and runoff intensities.
+
+For each predefined interval of soil loss or runoff, the relationship between nutrient loss and the driving variable is expressed as:
+
+\[
+y = m x + c
+\]
+
+where:  
+- \( y \) = nutrient loss (kg ha⁻¹)  
+- \( x \) = soil loss (t ha⁻¹) or runoff (%)  
+- \( m \) = slope of the regression line for interval 
+- \( c \) = intercept for interval
+
+Statistical significance of regression parameters was assessed at the 5% level (p < 0.05), ensuring that only meaningful and stable relationships were retained. Model predictions are generated dynamically based on user-provided inputs, and the appropriate regression segment is automatically selected according to the input range.
+
+The reliability of the output depends on the accuracy of input data. Results should be interpreted as **decision-support estimates** rather than exact measurements. The author shall not be responsible for any variations in the result.
+
+---
+
+# Installation
+
+Install using pip:
+
+pip install SoilRunNutri
+
+
+---
+
+# Quick Usage Guide
+
+
+import SoilRunNutri as srn 
+
+Load default input file (inputuser.txt)
+
+data = srn.load_input_file()
+
+Calculate nutrient loss using main functions
+
+nitrogen_loss = srn.nitrogen_loss(value, mode)
+
+phosphorus_loss = srn.phosphorus_loss(value, mode)
+
+potassium_loss = srn.potassium_loss(value, mode)
+
+print("Nitrogen loss:", nitrogen_loss)
+
+print("Phosphorus loss:", phosphorus_loss)
+
+print("Potassium loss:", potassium_loss)
+
+---
+
+# Functions Available
+
+
+| Function                                       | Description                                          | Example                                             |
+| ---------------------------------------------- | ---------------------------------------------------- | ----------------------------------------------------|
+| `nitrogen_loss(value, mode)`                   | Returns estimated N loss (kg ha⁻¹)                   | nitrogen_loss   = srn.nitrogen_loss(14, Soil loss)   |                                               
+| `phosphorus_loss(value, mode)`                 | Returns estimated P loss (kg ha⁻¹)                   | phosphorus_loss = srn.phosphorus_loss(20, Soil loss) |                                                 
+| `potassium_loss(value, mode)`                  | Returns estimated K loss (kg ha⁻¹)                   | potassium_loss  = srn.potassium_loss(10 , Run off)   |                                                  
+| `load_input_file(file_path="inputuser.txt")`   | Loads a text input file with soil loss & runoff data |                                                     |
+
+
+
+
+ 
+
+
+
+
+
+

soilrunnutri-0.1.13.dist-info/RECORD

@@ -0,0 +1,7 @@
+SoilRunNutri/__init__.py,sha256=INdfw_VNsHznuPb_SGqMv5KqsfiYLgie_yhu2hz2cO8,596
+SoilRunNutri/model.py,sha256=2Fa2ToNVwMGcNtGpXF5eEtutpP5FkxK0V0MpFDiZRfg,3634
+soilrunnutri-0.1.13.dist-info/licenses/LICENSE,sha256=GfnTf_WgKo06BbEPud_ZXVBPovqxIM68FCTMs-0HBio,1089
+soilrunnutri-0.1.13.dist-info/METADATA,sha256=rYwUKLMi9kXJmZQy1wzh6m3u0SK-s8w56GYR0WTr-_U,5455
+soilrunnutri-0.1.13.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+soilrunnutri-0.1.13.dist-info/top_level.txt,sha256=MmLOTR4mPG27B7oNvL1c26AZW6v9cfu9lqoRsYBAiAo,13
+soilrunnutri-0.1.13.dist-info/RECORD,,

soilrunnutri-0.1.13.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

soilrunnutri-0.1.13.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Soumya Pant
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+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.

soilrunnutri-0.1.13.dist-info/top_level.txt

@@ -0,0 +1 @@
+SoilRunNutri