TEflow


NameTEflow JSON
Version 0.4.2 PyPI version JSON
download
home_pagehttps://github.com/JianboHIT/TEflow
SummaryA python3 package for thermoelectric output performance calculations
upload_time2024-12-19 07:11:50
maintainerNone
docs_urlNone
authorJianbo ZHU
requires_pythonNone
licenseApache-2.0 license
keywords thermoelectricity simulation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # TEflow
A python3 package for streamlining thermoelectric workflow from materials to devices

## Features
- Model carrier transport
  - Single parabolic band (SPB) model
  - Single Kane band (SKB) model
  - Multiple bands model
  - Customized band model
- Debye model of lattice thermal conductivity
  - Calculations & Fitting
  - Scattering Mechanisms, e.g., three-phonon, point defects, etc.
  - Bipolar thermal conductivity
- Engineering performance of thermoelectric generator[^1]
  - Engineering dimensionless figure of merit (ZT<sub>eng</sub>) and power factor (PF<sub>eng</sub>)
  - Maximum Efficiency (η<sub>max</sub>) and ouput power density (P<sub>d</sub>)
  - R<sub>L</sub>- (external electric load resistance) or I- (electric current density) dependent properties, e.g. output voltage (V), heat flux (Q<sub>hot</sub>)
- Device ZT of thermoelectric generator[^2]
  - Maximum thermoelectric device efficiency
  - Optimized relative current density $u$
  - Thermoelectric potential $\Phi$
- Thermoelectric data manipulation
  - Thermoelectric data interpolation and extrapolation
  - Cut-off thermoelectric data at the threshold temperature
  - Join and rearrange parallel data files
  - Mix parallel data files with linear combination

<br/><br/>
#### References

[^1]: Kim, H. S., Liu, W., Chen, G., Chu, C. W., & Ren, Z. (2015). Relationship between thermoelectric figure of merit and energy conversion efficiency. 
_Proceedings of the National Academy of Sciences_, 112(27), 8205-8210. DOI: [10.1073/pnas.1510231112](https://doi.org/10.1073/pnas.1510231112)

[^2]: Snyder, G. J., & Snyder, A. H. (2017). Figure of merit ZT of a thermoelectric device defined from materials properties. 
_Energy & Environmental Science_, 10(11), 2280-2283. DOI: [10.1039/C7EE02007D](https://doi.org/10.1039/C7EE02007D)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/JianboHIT/TEflow",
    "name": "TEflow",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "thermoelectricity, simulation",
    "author": "Jianbo ZHU",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/a7/e7/2549a5a82b581d28059452237647d675e71be5bf119aa83c61cd3cb13c82/teflow-0.4.2.tar.gz",
    "platform": null,
    "description": "# TEflow\nA python3 package for streamlining thermoelectric workflow from materials to devices\n\n## Features\n- Model carrier transport\n  - Single parabolic band (SPB) model\n  - Single Kane band (SKB) model\n  - Multiple bands model\n  - Customized band model\n- Debye model of lattice thermal conductivity\n  - Calculations & Fitting\n  - Scattering Mechanisms, e.g., three-phonon, point defects, etc.\n  - Bipolar thermal conductivity\n- Engineering performance of thermoelectric generator[^1]\n  - Engineering dimensionless figure of merit (ZT<sub>eng</sub>) and power factor (PF<sub>eng</sub>)\n  - Maximum Efficiency (\u03b7<sub>max</sub>) and ouput power density (P<sub>d</sub>)\n  - R<sub>L</sub>- (external electric load resistance) or I- (electric current density) dependent properties, e.g. output voltage (V), heat flux (Q<sub>hot</sub>)\n- Device ZT of thermoelectric generator[^2]\n  - Maximum thermoelectric device efficiency\n  - Optimized relative current density $u$\n  - Thermoelectric potential $\\Phi$\n- Thermoelectric data manipulation\n  - Thermoelectric data interpolation and extrapolation\n  - Cut-off thermoelectric data at the threshold temperature\n  - Join and rearrange parallel data files\n  - Mix parallel data files with linear combination\n\n<br/><br/>\n#### References\n\n[^1]: Kim, H. S., Liu, W., Chen, G., Chu, C. W., & Ren, Z. (2015). Relationship between thermoelectric figure of merit and energy conversion efficiency. \n_Proceedings of the National Academy of Sciences_, 112(27), 8205-8210. DOI: [10.1073/pnas.1510231112](https://doi.org/10.1073/pnas.1510231112)\n\n[^2]: Snyder, G. J., & Snyder, A. H. (2017). Figure of merit ZT of a thermoelectric device defined from materials properties. \n_Energy & Environmental Science_, 10(11), 2280-2283. DOI: [10.1039/C7EE02007D](https://doi.org/10.1039/C7EE02007D)\n",
    "bugtrack_url": null,
    "license": "Apache-2.0 license",
    "summary": "A python3 package for thermoelectric output performance calculations",
    "version": "0.4.2",
    "project_urls": {
        "Homepage": "https://github.com/JianboHIT/TEflow"
    },
    "split_keywords": [
        "thermoelectricity",
        " simulation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bd8a8662f9df42c814989565939be274d836088051009dca2972af016e68f083",
                "md5": "017a6121e06faa17cd14163a7d0baa2f",
                "sha256": "ea3b2a1f507d4b1976e1ee673d6a7bbb71a5927b5b2b2e49c4494d18ab3fb1a2"
            },
            "downloads": -1,
            "filename": "TEflow-0.4.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "017a6121e06faa17cd14163a7d0baa2f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 79505,
            "upload_time": "2024-12-19T07:11:48",
            "upload_time_iso_8601": "2024-12-19T07:11:48.612071Z",
            "url": "https://files.pythonhosted.org/packages/bd/8a/8662f9df42c814989565939be274d836088051009dca2972af016e68f083/TEflow-0.4.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a7e72549a5a82b581d28059452237647d675e71be5bf119aa83c61cd3cb13c82",
                "md5": "3c6d8f67111aed9feea29e2e448c9b2d",
                "sha256": "3be2f526cec1e4d525911c3f518f2c8ce02d8ee870f4e9e8a7a91a88ea042896"
            },
            "downloads": -1,
            "filename": "teflow-0.4.2.tar.gz",
            "has_sig": false,
            "md5_digest": "3c6d8f67111aed9feea29e2e448c9b2d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 74878,
            "upload_time": "2024-12-19T07:11:50",
            "upload_time_iso_8601": "2024-12-19T07:11:50.742680Z",
            "url": "https://files.pythonhosted.org/packages/a7/e7/2549a5a82b581d28059452237647d675e71be5bf119aa83c61cd3cb13c82/teflow-0.4.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-19 07:11:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "JianboHIT",
    "github_project": "TEflow",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "teflow"
}
        
Elapsed time: 0.66726s