tdmrsdm 2025.7.1.dev1__tar.gz

tdmrsdm-2025.7.1.dev1/.gitignore

@@ -0,0 +1,161 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+dataset/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

tdmrsdm-2025.7.1.dev1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Morteza Khazaei
+
+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.

tdmrsdm-2025.7.1.dev1/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: tdmrsdm
+Version: 2025.7.1.dev1
+Summary: A Temperature-Dependent Multi-Relaxation Spectroscopic Dielectric Model (TD-MRSDM).
+Author-email: Morteza Khazaei <morteza.khazaei@usherbrooke.ca>
+License: MIT License
+Project-URL: Homepage, https://github.com/Morteza-Khazaei/TD-MRSDM
+Project-URL: Repository, https://github.com/Morteza-Khazaei/TD-MRSDM
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: matplotlib
+Requires-Dist: seaborn
+Requires-Dist: numpy
+Dynamic: license-file
+
+# TD-MRSDM
+
+[![Python Version](https://img.shields.io/badge/python-3.7%20|%203.8%20|%203.9-blue.svg)](https://www.python.org/downloads/)
+
+
+This Python package, based on the paper titled [Spectroscopic Multirelaxation Dielectric Model of Thawed and Frozen Arctic Soils Considering the Dependence on Temperature and Organic Matter Content](https://doi.org/10.1134/S0001433819090305), provides an implementation of the temperature-dependent multi-relaxation spectroscopic dielectric model described in the paper. The model is designed for characterizing the dielectric properties of organic soil at frequencies ranging from 0.05 to 15 GHz under various temperature conditions.
+
+<p float="center">
+<img src="figures/TD-MRSDM.png" width="800">
+</p>
+
+## Installation
+
+To use **TD-MRSDM**, you need to install it first. You can install it using `pip`:
+
+```bash
+pip install tdmrsdm
+```
+
+## Usage
+
+Here's a simple example of how to use the smwlst package to compute LST:
+
+```python
+import numpy as np
+import matplotlib.pyplot as plt
+import seaborn as sns
+from tdmrsdm import TDMRSDM
+
+
+# Define temperature and MgCl2 concentration ranges
+ssts = np.arange(-30, 26, 1)  # From -30 to 25 degrees Celsius
+mvs = np.arange(0, 0.86, 0.01) # From 0 to 0.85
+
+# Create empty lists to store results
+epsr_values = []
+epsi_values = []
+moisture_values = []
+
+
+# Loop through soil moisture content
+for mv in mvs:
+    for sst in ssts:
+        mrsdm = TDMRSDM(freq_GHz=1.41, sst=sst, som=25, sbd=0.95, ssm=mv)
+        eps = mrsdm.run()
+        epsr, epsi = eps.real, eps.imag
+        epsr_values.append(epsr[0]) # Access the first element because epsr is an array
+        epsi_values.append(epsi[0]) # Access the first element because epsi is an array
+        moisture_values.append(mv)
+
+
+# Create the plot using seaborn
+plt.figure(figsize=(10, 6))
+sns.lineplot(x=moisture_values, y=epsr_values, label='Real Soil DC')
+sns.lineplot(x=moisture_values, y=epsi_values, label='Imaginary Soil DC')
+
+plt.xlabel('Soil Moisture (g/g)')
+plt.ylabel('Soil DC')
+plt.title('Real and Imaginary Soil DC as a Function of Soil Moisture')
+plt.legend()
+plt.grid(True)
+plt.show()
+
+```
+<p float="center">
+<img src="figures/soil_dc_vs_ssm.png" width="800">
+</p>
+
+>[!WARNING]
+>**Copyright Notice:** This code is part of a PhD research program and is not licensed for public use or distribution yet! All rights are reserved by the author [**Morteza Khazaei**]. Unauthorized use, reproduction, or distribution of this code is prohibited without prior written permission from the author. For inquiries or collaboration, please contact [morteza.khazaei@usherbrooke.ca](morteza.khazaei@usherbrooke.ca).
+
+## Authors
+
+- [Morteza Khazaei - [morteza.khazaei@usherbrooke.ca]](https://github.com/Morteza-Khazaei)
+
+## References
+
+- [Mironov, V., & Savin, I. (2015). A temperature-dependent multi-relaxation spectroscopic dielectric model for thawed and frozen organic soil at 0.05–15 GHz. Physics and Chemistry of the Earth, Parts A/B/C, 83, 57-64.](https://doi.org/10.1016/j.pce.2015.02.011)

tdmrsdm-2025.7.1.dev1/README.md

@@ -0,0 +1,78 @@
+# TD-MRSDM
+
+[![Python Version](https://img.shields.io/badge/python-3.7%20|%203.8%20|%203.9-blue.svg)](https://www.python.org/downloads/)
+
+
+This Python package, based on the paper titled [Spectroscopic Multirelaxation Dielectric Model of Thawed and Frozen Arctic Soils Considering the Dependence on Temperature and Organic Matter Content](https://doi.org/10.1134/S0001433819090305), provides an implementation of the temperature-dependent multi-relaxation spectroscopic dielectric model described in the paper. The model is designed for characterizing the dielectric properties of organic soil at frequencies ranging from 0.05 to 15 GHz under various temperature conditions.
+
+<p float="center">
+<img src="figures/TD-MRSDM.png" width="800">
+</p>
+
+## Installation
+
+To use **TD-MRSDM**, you need to install it first. You can install it using `pip`:
+
+```bash
+pip install tdmrsdm
+```
+
+## Usage
+
+Here's a simple example of how to use the smwlst package to compute LST:
+
+```python
+import numpy as np
+import matplotlib.pyplot as plt
+import seaborn as sns
+from tdmrsdm import TDMRSDM
+
+
+# Define temperature and MgCl2 concentration ranges
+ssts = np.arange(-30, 26, 1)  # From -30 to 25 degrees Celsius
+mvs = np.arange(0, 0.86, 0.01) # From 0 to 0.85
+
+# Create empty lists to store results
+epsr_values = []
+epsi_values = []
+moisture_values = []
+
+
+# Loop through soil moisture content
+for mv in mvs:
+    for sst in ssts:
+        mrsdm = TDMRSDM(freq_GHz=1.41, sst=sst, som=25, sbd=0.95, ssm=mv)
+        eps = mrsdm.run()
+        epsr, epsi = eps.real, eps.imag
+        epsr_values.append(epsr[0]) # Access the first element because epsr is an array
+        epsi_values.append(epsi[0]) # Access the first element because epsi is an array
+        moisture_values.append(mv)
+
+
+# Create the plot using seaborn
+plt.figure(figsize=(10, 6))
+sns.lineplot(x=moisture_values, y=epsr_values, label='Real Soil DC')
+sns.lineplot(x=moisture_values, y=epsi_values, label='Imaginary Soil DC')
+
+plt.xlabel('Soil Moisture (g/g)')
+plt.ylabel('Soil DC')
+plt.title('Real and Imaginary Soil DC as a Function of Soil Moisture')
+plt.legend()
+plt.grid(True)
+plt.show()
+
+```
+<p float="center">
+<img src="figures/soil_dc_vs_ssm.png" width="800">
+</p>
+
+>[!WARNING]
+>**Copyright Notice:** This code is part of a PhD research program and is not licensed for public use or distribution yet! All rights are reserved by the author [**Morteza Khazaei**]. Unauthorized use, reproduction, or distribution of this code is prohibited without prior written permission from the author. For inquiries or collaboration, please contact [morteza.khazaei@usherbrooke.ca](morteza.khazaei@usherbrooke.ca).
+
+## Authors
+
+- [Morteza Khazaei - [morteza.khazaei@usherbrooke.ca]](https://github.com/Morteza-Khazaei)
+
+## References
+
+- [Mironov, V., & Savin, I. (2015). A temperature-dependent multi-relaxation spectroscopic dielectric model for thawed and frozen organic soil at 0.05–15 GHz. Physics and Chemistry of the Earth, Parts A/B/C, 83, 57-64.](https://doi.org/10.1016/j.pce.2015.02.011)

tdmrsdm-2025.7.1.dev1/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=61.0", "setuptools-scm>=8.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tdmrsdm"
+description = "A Temperature-Dependent Multi-Relaxation Spectroscopic Dielectric Model (TD-MRSDM)."
+readme = "README.md"
+authors = [
+    { name = "Morteza Khazaei", email = "morteza.khazaei@usherbrooke.ca" },
+]
+license = { text = "MIT License" }
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "matplotlib",
+    "seaborn",
+    "numpy",
+
+]
+dynamic = ["version"]
+
+[project.urls]
+"Homepage" = "https://github.com/Morteza-Khazaei/TD-MRSDM"
+"Repository" = "https://github.com/Morteza-Khazaei/TD-MRSDM"
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+include-package-data = true
+
+[tool.setuptools_scm]
+version_scheme = "python-simplified-semver"
+local_scheme = "no-local-version"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+exclude = ["dataset"]
+
+[tool.setuptools.package-data]
+tdmrsdm = ["constants/*.json"]

tdmrsdm-2025.7.1.dev1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tdmrsdm-2025.7.1.dev1/setup.py

@@ -0,0 +1,4 @@
+from setuptools import setup
+
+if __name__ == "__main__":
+    setup()

tdmrsdm-2025.7.1.dev1/src/tdmrsdm/constants/td_mrsdm_constants_v2019.json

@@ -0,0 +1,154 @@
+{
+    "TD-MRSDM-constants": {
+        "water-phase": {
+            "bound-water": {
+                "relaxation-time": {
+                    "low-frequency": {
+                        "t_lte_-1C": {
+                            "e0p": 86,
+                            "bv0p": -1.22E-4,
+                            "tse0p": -25,
+                            "dHp/R": 362,
+                            "dSp/R": -9.93
+                        }, 
+                        "t_gte_0C": {
+                            "e0p": 110,
+                            "bv0p": -1.1E-4,
+                            "tse0p": 25,
+                            "dHp/R": 662,
+                            "dSp/R": -8.82
+                        }
+                    },
+                    "mid-frequency": {
+                        "t_lte_-1C": {
+                            "e0p": 13,
+                            "bv0p": -3.95E-3,
+                            "tse0p": -25,
+                            "dHp/R": 617,
+                            "dSp/R": -4.81
+                        },
+                        "t_gte_0C": {
+                            "e0p": 30,
+                            "bv0p": -1.82E-3,
+                            "tse0p": 25,
+                            "dHp/R": 493,
+                            "dSp/R": -5.65
+                        }
+                    },
+                    "high-frequency": {
+                        "t_lte_-1C": {
+                            "e0p": 8,
+                            "bv0p": -1.14E-3,
+                            "tse0p": -25,
+                            "dHp/R": 671,
+                            "dSp/R": -2.5
+                        },
+                        "t_gte_0C": {
+                            "e0p": 13,
+                            "bv0p": -3.83E-3,
+                            "tse0p": 25,
+                            "dHp/R": 366,
+                            "dSp/R": -3.79
+                        }
+                    }
+                },
+                "electrical-conductivity": {
+                    "temperature-range": {
+                        "t_lte_-1C": {
+                            "sigma(tsp)": 5E-3,
+                            "betap": 0,
+                            "tsp": -25
+                        },
+                        "t_gte_0C": {
+                            "sigma(tsp)": 5E-3,
+                            "betap": 0,
+                            "tsp": 25
+                        }
+                    }}
+            },
+            "transient-water": {
+                "relaxation-time": {
+                    "low-frequency": {
+                        "t_lte_-1C": {
+                            "e0p": 75,
+                            "bv0p": -5.02E-4,
+                            "tse0p": -25,
+                            "dHp/R": 2837,
+                            "dSp/R": 3.45
+                        },
+                        "t_gte_0C": {
+                            "e0p": 97,
+                            "bv0p": 7.48E-5,
+                            "tse0p": 25,
+                            "dHp/R": 2133,
+                            "dSp/R": 0.74
+                        }
+                    },
+                    "high-frequency": {
+                        "t_lte_-1C": {
+                            "e0p": 22,
+                            "bv0p": -2.89E-3,
+                            "tse0p": -25,
+                            "dHp/R": 2870,
+                            "dSp/R": 5.88
+                        },
+                        "t_gte_0C": {
+                            "e0p": 58,
+                            "bv0p": -1.93E-4,
+                            "tse0p": 25,
+                            "dHp/R": 1849,
+                            "dSp/R": 1.81
+                        }
+                    }
+                },
+                "electrical-conductivity": {
+                    "temperature-range": {
+                        "t_lte_-1C": {
+                            "sigma(tsp)": 0.01,
+                            "betap": 0,
+                            "tsp": -25
+                        },
+                        "t_gte_0C": {
+                            "sigma(tsp)": 0.01,
+                            "betap": 0,
+                            "tsp": 25
+                        }
+                    }}
+            },
+            "ice-unbound-water": {
+                "relaxation-time": {
+                    "low-frequency": {
+                        "t_lte_-1C": {
+                            "e0p": 6,
+                            "bv0p": -11.3E-3,
+                            "tse0p": -25,
+                            "dHp/R": 3484,
+                            "dSp/R": 7.78
+                        }
+                    },
+                    "high-frequency": {
+                        "t_gte_0C": {
+                            "e0p": 85,
+                            "bv0p": 1.53E-4,
+                            "tse0p": 25,
+                            "dHp/R": 2319,
+                            "dSp/R": 3.72
+                        }
+                    }
+                },
+                "electrical-conductivity": {
+                    "temperature-range": {
+                        "t_lte_-1C": {
+                            "sigma(tsp)": 0.008,
+                            "betap": 1.15E-3,
+                            "tsp": -25
+                        },
+                        "t_gte_0C": {
+                            "sigma(tsp)": 0.26,
+                            "betap": 3.3E-3,
+                            "tsp": 25
+                        }
+                    }}
+            }
+        }}
+}