# kappamin
A python3 code for calculations of the minimum limit to thermal conductivity
<img src="PhononDispersionModel.jpg" width="85%">
## Features
- Models of the minimum limit to thermal conductivity under Cahill assumption[^1]
- Debye model[^2]
- BvK (Born–von Karman) model[^3]
- Pei model[^4]
- Temperature-dependence
- Finite temperature
- Ideal infinite temperature
- Relative
- Heat Capacity
- Minimum mean-free-path
- Minimum average phonon lifetime
- Running mode
- Command line mode based on a simple configuration file (for the routine analysis)
- Based on prepared scripts (for general researchers without programming skills)
- Use as a python module (for expert usage)
## Getting Started
The first step is to install `kappamin`. If you have internet access,
the most straightforward way to do this is via `pip`:
```
pip install kappamin
```
Please be patient as the installation completes.
For those without internet access,
instructions for source code installation can be found under the
[Offline Installation](#offline-installation) section.
In order to invoke `kappamin` module, you need to prepare a configuration file
(see [Example_Debye.txt](Example_Debye.txt)
and [Example_BvK.txt](Example_Debye.txt)
in the source package).
```
python -m kappamin [KAPPAMIN.txt]
```
Here `KAPPAMIN.txt` indicates the filename of configuration file.
It is worth mentioning that the filename is optional.
If the filename is not given, the program will read the file named as `KAPPAMIN.txt` if it existed.
Alternately, a more convenient way to implement calculation is by an executable script
(see [ExceuteScript.py](ExecuteScript.py)), then run it by python3.
On Linux or Windows Terminal:
```
python ExceuteScript.py
```
**On Windows, if it has been configured that the default program to open .py file is python3,
you just need to move ExceuteScript.py to the directory at where the configuration file is located
and *double-click* it to run.**
Moreover, advanced users may prefer to skip the command-line interface
and access the full feature set of `kappamin` more directly.
Those wanting to use the interpolation capabilities of `kappamin` in their own code,
or using it as part of an automated workflow,
ones can see [Example_AsModule.py](Example_AsModule.py).
## Feedback and report bugs
See [GitHub Issue page](https://github.com/JianboHIT/kappamin/issues).
## Offline Installation
To install `kappamin` in an offline environment,
please ensure that `numpy` and `scipy` are already successfully installed on your system.
Then, download the source code package of `kappamin` from GitHub
([https://github.com/JianboHIT/kappamin](https://github.com/JianboHIT/kappamin)).
This package is typically named `kappamin-master.zip`.
Unzip the package and enter the directory by executing:
```bash
unzip kappamin-master.zip; cd kappamin-master
```
Then, install the package by running:
```bash
python3 setup.py install
```
Please wait for the installation process to complete.
During this proces, you may encounter some warnings about this method of installation being deprecated.
Such warnings arise because this approach deviates from Python's official advice
and may not represent the most streamlined method currently known.
However, as long as `numpy` and `scipy` have been correctly installed beforehand,
these warnings can generally be disregarded. To date,
I have not identified an alternative strategy that matches this method's simplicity.
I sincerely welcome your recommendations for making the installation process smoother or more efficient.
I'm open to and thankful for any insights or suggestions you might have,
aiming to enhance the installation experience for all users.
## Change log
(More details see [CHANGELOG](CHANGELOG))
- 2024.03.05 v0.2.1 Support pip installation
- 2023.08.27 v0.2.0 Add Example_AsModule.py file
- 2022.10.16 v0.1.1 Fix crucial bug in Pei model
- 2022.10.16 v0.1.0 Develop Debye, BvK, and Pei models
- 2022.10.06 v0.0.1 Initial package version
<br/><br/>
## Reference
[^1]: D.G. Cahill, R.O. Pohl, Heat flow and lattice vibrations in glasses, Solid State Communications, 70 (10) (1989) 927-930. [https://doi.org/10.1016/0038-1098(89)90630-3](https://doi.org/10.1016/0038-1098(89)90630-3)
[^2]: P. Debye, Zur theorie der spezifischen wärmen, Annalen Der Physik, 344 (14) (1912) 789-839. [https://doi.org/10.1002/andp.19123441404](https://doi.org/10.1002/andp.19123441404)
[^3]: M. Born, T. Von Karman, Vibrations in space gratings (molecular frequencies), Z Phys, 13 (1912) 297-309.
[^4]: Z. Chen, X. Zhang, S. Lin, L. Chen, Y. Pei, Rationalizing phonon dispersion for lattice thermal conductivity of solids, National Science Review, 5 (6) (2018) 888-894. [https://doi.org/10.1093/nsr/nwy097](https://doi.org/10.1093/nsr/nwy097)
Raw data
{
"_id": null,
"home_page": "https://github.com/JianboHIT/kappamin",
"name": "kappamin",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "thermal-conductivity,limitation,condensed-matter-physics,phonon-transport",
"author": "Jianbo ZHU",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c2/e5/6add85a5fa657bae0b6449894413799068e9a66c65a47a7ed1aadab1e40f/kappamin-0.2.1.tar.gz",
"platform": null,
"description": "# kappamin\nA python3 code for calculations of the minimum limit to thermal conductivity\n\n<img src=\"PhononDispersionModel.jpg\" width=\"85%\">\n\n## Features\n\n- Models of the minimum limit to thermal conductivity under Cahill assumption[^1]\n - Debye model[^2]\n - BvK (Born\u2013von Karman) model[^3]\n - Pei model[^4]\n- Temperature-dependence\n - Finite temperature\n - Ideal infinite temperature\n- Relative\n - Heat Capacity\n - Minimum mean-free-path\n - Minimum average phonon lifetime\n- Running mode\n - Command line mode based on a simple configuration file (for the routine analysis)\n - Based on prepared scripts (for general researchers without programming skills)\n - Use as a python module (for expert usage)\n\n## Getting Started\n\nThe first step is to install `kappamin`. If you have internet access,\nthe most straightforward way to do this is via `pip`:\n\n```\npip install kappamin\n```\n\nPlease be patient as the installation completes.\nFor those without internet access,\ninstructions for source code installation can be found under the\n[Offline Installation](#offline-installation) section.\n\nIn order to invoke `kappamin` module, you need to prepare a configuration file \n(see [Example_Debye.txt](Example_Debye.txt)\nand [Example_BvK.txt](Example_Debye.txt)\nin the source package).\n\n```\npython -m kappamin [KAPPAMIN.txt]\n```\n\nHere `KAPPAMIN.txt` indicates the filename of configuration file. \nIt is worth mentioning that the filename is optional. \nIf the filename is not given, the program will read the file named as `KAPPAMIN.txt` if it existed.\n\nAlternately, a more convenient way to implement calculation is by an executable script\n(see [ExceuteScript.py](ExecuteScript.py)), then run it by python3. \nOn Linux or Windows Terminal:\n\n```\npython ExceuteScript.py\n```\n\n**On Windows, if it has been configured that the default program to open .py file is python3,\nyou just need to move ExceuteScript.py to the directory at where the configuration file is located\nand *double-click* it to run.**\n\nMoreover, advanced users may prefer to skip the command-line interface\nand access the full feature set of `kappamin` more directly. \nThose wanting to use the interpolation capabilities of `kappamin` in their own code, \nor using it as part of an automated workflow, \nones can see [Example_AsModule.py](Example_AsModule.py).\n\n## Feedback and report bugs\n\nSee [GitHub Issue page](https://github.com/JianboHIT/kappamin/issues).\n\n## Offline Installation\n\nTo install `kappamin` in an offline environment,\nplease ensure that `numpy` and `scipy` are already successfully installed on your system.\nThen, download the source code package of `kappamin` from GitHub\n([https://github.com/JianboHIT/kappamin](https://github.com/JianboHIT/kappamin)).\nThis package is typically named `kappamin-master.zip`.\nUnzip the package and enter the directory by executing:\n\n```bash\nunzip kappamin-master.zip; cd kappamin-master\n```\n\nThen, install the package by running:\n\n```bash\npython3 setup.py install\n```\n\nPlease wait for the installation process to complete.\nDuring this proces, you may encounter some warnings about this method of installation being deprecated.\nSuch warnings arise because this approach deviates from Python's official advice \nand may not represent the most streamlined method currently known.\nHowever, as long as `numpy` and `scipy` have been correctly installed beforehand,\nthese warnings can generally be disregarded. To date,\nI have not identified an alternative strategy that matches this method's simplicity.\nI sincerely welcome your recommendations for making the installation process smoother or more efficient.\nI'm open to and thankful for any insights or suggestions you might have,\naiming to enhance the installation experience for all users.\n\n## Change log\n\n(More details see [CHANGELOG](CHANGELOG))\n\n- 2024.03.05 v0.2.1 Support pip installation\n- 2023.08.27 v0.2.0 Add Example_AsModule.py file\n- 2022.10.16 v0.1.1 Fix crucial bug in Pei model\n- 2022.10.16 v0.1.0 Develop Debye, BvK, and Pei models\n- 2022.10.06 v0.0.1 Initial package version\n\n\n<br/><br/>\n\n## Reference\n\n[^1]: D.G. Cahill, R.O. Pohl, Heat flow and lattice vibrations in glasses, Solid State Communications, 70 (10) (1989) 927-930. [https://doi.org/10.1016/0038-1098(89)90630-3](https://doi.org/10.1016/0038-1098(89)90630-3)\n\n[^2]: P. Debye, Zur theorie der spezifischen w\u00e4rmen, Annalen Der Physik, 344 (14) (1912) 789-839. [https://doi.org/10.1002/andp.19123441404](https://doi.org/10.1002/andp.19123441404)\n\n[^3]: M. Born, T. Von Karman, Vibrations in space gratings (molecular frequencies), Z Phys, 13 (1912) 297-309.\n\n[^4]: Z. Chen, X. Zhang, S. Lin, L. Chen, Y. Pei, Rationalizing phonon dispersion for lattice thermal conductivity of solids, National Science Review, 5 (6) (2018) 888-894. [https://doi.org/10.1093/nsr/nwy097](https://doi.org/10.1093/nsr/nwy097)\n",
"bugtrack_url": null,
"license": "Apache-2.0 license",
"summary": "A python3 code for calculations of the minimum limit to thermal conductivity",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/JianboHIT/kappamin"
},
"split_keywords": [
"thermal-conductivity",
"limitation",
"condensed-matter-physics",
"phonon-transport"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9aa0d915ccef51361469af60c576d3d0475452e278270dacea61fae6809d262a",
"md5": "837d4d5e96954faa1611db01fb61ec56",
"sha256": "bfafc63ee91c365334bb1f1828829ac207058cc57da610d38dac54035d1ec551"
},
"downloads": -1,
"filename": "kappamin-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "837d4d5e96954faa1611db01fb61ec56",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11407,
"upload_time": "2024-03-07T15:23:42",
"upload_time_iso_8601": "2024-03-07T15:23:42.456577Z",
"url": "https://files.pythonhosted.org/packages/9a/a0/d915ccef51361469af60c576d3d0475452e278270dacea61fae6809d262a/kappamin-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c2e56add85a5fa657bae0b6449894413799068e9a66c65a47a7ed1aadab1e40f",
"md5": "ea093ef98591e0fb1c3b4dff6cb0fe70",
"sha256": "481bf6dbee534acd1efe5f205326cf63e11e86a205440983feda7058be327a04"
},
"downloads": -1,
"filename": "kappamin-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "ea093ef98591e0fb1c3b4dff6cb0fe70",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11404,
"upload_time": "2024-03-07T15:23:44",
"upload_time_iso_8601": "2024-03-07T15:23:44.838523Z",
"url": "https://files.pythonhosted.org/packages/c2/e5/6add85a5fa657bae0b6449894413799068e9a66c65a47a7ed1aadab1e40f/kappamin-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-07 15:23:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JianboHIT",
"github_project": "kappamin",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "kappamin"
}
JSON
