tanabesugano


Nametanabesugano JSON
Version 1.4.3 PyPI version JSON
download
home_pagehttps://pypi.org/project/TanabeSugano
SummaryA python-solver for Tanabe-Sugano and Energy-Correlation diagrams
upload_time2023-12-20 12:21:47
maintainerAnselm Hahn
docs_urlNone
authorAnselm Hahn
requires_python>=3.8.1,<4.0
licenseMIT
keywords terminal data-visualization tanabe-sugano energy-correlation complex-ions
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Python Package](https://github.com/Anselmoo/TanabeSugano/actions/workflows/python-package.yml/badge.svg)](https://github.com/Anselmoo/TanabeSugano/actions/workflows/python-package.yml)
[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
[![CodeFactor](https://www.codefactor.io/repository/github/anselmoo/tanabesugano/badge)](https://www.codefactor.io/repository/github/anselmoo/tanabesugano)
[![DOI](https://zenodo.org/badge/206847682.svg)](https://zenodo.org/badge/latestdoi/206847682)
[![GitHub](https://img.shields.io/github/license/Anselmoo/TanabeSugano)](https://github.com/Anselmoo/TanabeSugano/blob/master/LICENSE)
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/Anselmoo/TanabeSugano?include_prereleases)](https://github.com/Anselmoo/TanabeSugano/releases)
[![PyPI](https://img.shields.io/pypi/v/TanabeSugano?logo=Pypi&logoColor=yellow)](https://pypi.org/project/TanabeSugano/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/TanabeSugano?logo=Python&logoColor=yellow)](https://pypi.org/project/TanabeSugano/)
[![Downloads](https://static.pepy.tech/badge/tanabesugano)](https://pepy.tech/project/tanabesugano)
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Anselmoo/TanabeSugano/blob/master/Tanabe_Sugano.ipynb)


# TanabeSugano
A python-based Eigensolver for Tanabe-Sugano- & Energy-Correlation-Diagrams based on the original three proposed studies of *Yukito Tanabe and Satoru Sugano* for d<sup>2</sup>-d<sup>8</sup> transition metal ions:

1. On the Absorption Spectra of Complex Ions. I

    **Yukito Tanabe, Satoru Sugano**
    *Journal of the Physical Society of Japan*, 9, 753-766 (1954)
    **DOI:** 10.1143/JPSJ.9.753
    https://journals.jps.jp/doi/10.1143/JPSJ.9.753

2. On the Absorption Spectra of Complex Ions II

    **Yukito Tanabe, Satoru Sugano**
    *Journal of the Physical Society of Japan*, 9, 766-779 (1954)
    **DOI:** 10.1143/JPSJ.9.766
    https://journals.jps.jp/doi/10.1143/JPSJ.9.766

3. On the Absorption Spectra of Complex Ions, III The Calculation of the Crystalline Field Strength

    **Yukito Tanabe, Satoru Sugano**
    *Journal of the Physical Society of Japan*, 11, 864-877 (1956)
    **DOI:** 10.1143/JPSJ.11.864
    https://journals.jps.jp/doi/10.1143/JPSJ.11.864

It provides:

- Tanabe-Sugano- & Energy-Correlation-Diagrams plotted via `matplotlib`
- Tanabe-Sugano- & Energy-Correlation-Diagrams exported as `txt`-file
- Atomic-Termsymbols and their **Eigen-Energies** for a given 10Dq and oxidation state as exported table via `prettytable`
- Set-up individually **C/B**-ratios
- Working with Slater-Condon-Parameters **F<sup>2</sup>, F<sup>4</sup>** instead of Racah-Parameters **B, C**
- Export of the **Tanabe-Sugano-Diagram** as a `html`-file via `plotly` for interactive use

The **TanabeSugano**-application can be installed and run:

```console
    # via PyPi
    pip install TanabeSugano

    # via pip+git
    pip git+https://github.com/Anselmoo/TanabeSugano.git

    # locally
    python setup.py install
    tanabesugano

    # for plotly-export
    pip install TanabeSugano[plotly]
```


The options for the **TanabeSugano**-application are:

```console
    tanabesugano --help

    usage: __main__.py [-h] [-d D] [-Dq DQ] [-cut CUT] [-B B B] [-C C C] [-n N]
                   [-ndisp] [-ntxt] [-slater]

    optional arguments:
    -h, --help     show this help message and exit
    -d D           Number of unpaired electrons (default d5)
    -Dq DQ         10Dq crystal field splitting (default 10Dq = 8065 cm-)
    -cut CUT       10Dq crystal field splitting (default 10Dq = 8065 cm-)
    -B B B         Racah Parameter B and the corresponding reduction (default B = 860 cm- * 1.)
    -C C C         Racah Parameter C and the corresponding reduction (default C = 4.477*860 cm- * 1.)
    -n N           Number of roots (default nroots = 500)
    -ndisp         Plot TS-diagram (default = on)
    -ntxt          Save TS-diagram and dd energies (default = on)
    -slater        Using Slater-Condon F2,F4 parameter instead Racah-Parameter B,C (default = off)
    -v, --version  Print version number and exit
    -html          Save TS-diagram and dd energies (default = on)
```

**Reference-Example** for d<sup>6</sup> for *B = 860 cm<sup>-</sup>* and *C = 3850 cm<sup>-</sup>* as regular `matplotlib`-plot:
![placeholder](https://github.com/Anselmoo/TanabeSugano/blob/master/examples/dd-diagram_for_d6.png?raw=true)


**Reference-Example** for d<sup>6</sup> for *F<sup>2</sup> = 1065 cm<sup>-</sup>* and *F<sup>4</sup> = 5120 cm<sup>-</sup>* as interactive `plotly`-plot:

![placeholder](https://github.com/Anselmoo/TanabeSugano/blob/master/examples/d6_ts_interactive.gif?raw=true)

## Test the TS-diagrams interactively in Google Colab

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Anselmoo/TanabeSugano/blob/master/Tanabe_Sugano.ipynb)


            

Raw data

            {
    "_id": null,
    "home_page": "https://pypi.org/project/TanabeSugano",
    "name": "tanabesugano",
    "maintainer": "Anselm Hahn",
    "docs_url": null,
    "requires_python": ">=3.8.1,<4.0",
    "maintainer_email": "anselm.hahn@gmail.com",
    "keywords": "terminal,data-visualization,tanabe-sugano,energy-correlation,complex-ions",
    "author": "Anselm Hahn",
    "author_email": "anselm.hahn@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/32/bb/e25584872d17aa1ac62d3fc1b0a6fe53f684b761bbedcb3f01911918f0ac/tanabesugano-1.4.3.tar.gz",
    "platform": null,
    "description": "[![Python Package](https://github.com/Anselmoo/TanabeSugano/actions/workflows/python-package.yml/badge.svg)](https://github.com/Anselmoo/TanabeSugano/actions/workflows/python-package.yml)\n[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)\n[![CodeFactor](https://www.codefactor.io/repository/github/anselmoo/tanabesugano/badge)](https://www.codefactor.io/repository/github/anselmoo/tanabesugano)\n[![DOI](https://zenodo.org/badge/206847682.svg)](https://zenodo.org/badge/latestdoi/206847682)\n[![GitHub](https://img.shields.io/github/license/Anselmoo/TanabeSugano)](https://github.com/Anselmoo/TanabeSugano/blob/master/LICENSE)\n[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/Anselmoo/TanabeSugano?include_prereleases)](https://github.com/Anselmoo/TanabeSugano/releases)\n[![PyPI](https://img.shields.io/pypi/v/TanabeSugano?logo=Pypi&logoColor=yellow)](https://pypi.org/project/TanabeSugano/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/TanabeSugano?logo=Python&logoColor=yellow)](https://pypi.org/project/TanabeSugano/)\n[![Downloads](https://static.pepy.tech/badge/tanabesugano)](https://pepy.tech/project/tanabesugano)\n[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Anselmoo/TanabeSugano/blob/master/Tanabe_Sugano.ipynb)\n\n\n# TanabeSugano\nA python-based Eigensolver for Tanabe-Sugano- & Energy-Correlation-Diagrams based on the original three proposed studies of *Yukito Tanabe and Satoru Sugano* for d<sup>2</sup>-d<sup>8</sup> transition metal ions:\n\n1. On the Absorption Spectra of Complex Ions. I\n\n    **Yukito Tanabe, Satoru Sugano**\n    *Journal of the Physical Society of Japan*, 9, 753-766 (1954)\n    **DOI:** 10.1143/JPSJ.9.753\n    https://journals.jps.jp/doi/10.1143/JPSJ.9.753\n\n2. On the Absorption Spectra of Complex Ions II\n\n    **Yukito Tanabe, Satoru Sugano**\n    *Journal of the Physical Society of Japan*, 9, 766-779 (1954)\n    **DOI:** 10.1143/JPSJ.9.766\n    https://journals.jps.jp/doi/10.1143/JPSJ.9.766\n\n3. On the Absorption Spectra of Complex Ions, III The Calculation of the Crystalline Field Strength\n\n    **Yukito Tanabe, Satoru Sugano**\n    *Journal of the Physical Society of Japan*, 11, 864-877 (1956)\n    **DOI:** 10.1143/JPSJ.11.864\n    https://journals.jps.jp/doi/10.1143/JPSJ.11.864\n\nIt provides:\n\n- Tanabe-Sugano- & Energy-Correlation-Diagrams plotted via `matplotlib`\n- Tanabe-Sugano- & Energy-Correlation-Diagrams exported as `txt`-file\n- Atomic-Termsymbols and their **Eigen-Energies** for a given 10Dq and oxidation state as exported table via `prettytable`\n- Set-up individually **C/B**-ratios\n- Working with Slater-Condon-Parameters **F<sup>2</sup>, F<sup>4</sup>** instead of Racah-Parameters **B, C**\n- Export of the **Tanabe-Sugano-Diagram** as a `html`-file via `plotly` for interactive use\n\nThe **TanabeSugano**-application can be installed and run:\n\n```console\n    # via PyPi\n    pip install TanabeSugano\n\n    # via pip+git\n    pip git+https://github.com/Anselmoo/TanabeSugano.git\n\n    # locally\n    python setup.py install\n    tanabesugano\n\n    # for plotly-export\n    pip install TanabeSugano[plotly]\n```\n\n\nThe options for the **TanabeSugano**-application are:\n\n```console\n    tanabesugano --help\n\n    usage: __main__.py [-h] [-d D] [-Dq DQ] [-cut CUT] [-B B B] [-C C C] [-n N]\n                   [-ndisp] [-ntxt] [-slater]\n\n    optional arguments:\n    -h, --help     show this help message and exit\n    -d D           Number of unpaired electrons (default d5)\n    -Dq DQ         10Dq crystal field splitting (default 10Dq = 8065 cm-)\n    -cut CUT       10Dq crystal field splitting (default 10Dq = 8065 cm-)\n    -B B B         Racah Parameter B and the corresponding reduction (default B = 860 cm- * 1.)\n    -C C C         Racah Parameter C and the corresponding reduction (default C = 4.477*860 cm- * 1.)\n    -n N           Number of roots (default nroots = 500)\n    -ndisp         Plot TS-diagram (default = on)\n    -ntxt          Save TS-diagram and dd energies (default = on)\n    -slater        Using Slater-Condon F2,F4 parameter instead Racah-Parameter B,C (default = off)\n    -v, --version  Print version number and exit\n    -html          Save TS-diagram and dd energies (default = on)\n```\n\n**Reference-Example** for d<sup>6</sup> for *B = 860 cm<sup>-</sup>* and *C = 3850 cm<sup>-</sup>* as regular `matplotlib`-plot:\n![placeholder](https://github.com/Anselmoo/TanabeSugano/blob/master/examples/dd-diagram_for_d6.png?raw=true)\n\n\n**Reference-Example** for d<sup>6</sup> for *F<sup>2</sup> = 1065 cm<sup>-</sup>* and *F<sup>4</sup> = 5120 cm<sup>-</sup>* as interactive `plotly`-plot:\n\n![placeholder](https://github.com/Anselmoo/TanabeSugano/blob/master/examples/d6_ts_interactive.gif?raw=true)\n\n## Test the TS-diagrams interactively in Google Colab\n\n[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Anselmoo/TanabeSugano/blob/master/Tanabe_Sugano.ipynb)\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A python-solver for Tanabe-Sugano and Energy-Correlation diagrams",
    "version": "1.4.3",
    "project_urls": {
        "Homepage": "https://pypi.org/project/TanabeSugano",
        "Repository": "https://github.com/Anselmoo/TanabeSugano"
    },
    "split_keywords": [
        "terminal",
        "data-visualization",
        "tanabe-sugano",
        "energy-correlation",
        "complex-ions"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f06c4cd61ef35f344f4dbf21abde944822a35c53de26062096439d3af179b83c",
                "md5": "493ed849467956100055f6bf022255d5",
                "sha256": "9c2ebb8f07fdc19d813debabb4c5ddabfbc7dc60baa487ce072e92be0ff9e9cc"
            },
            "downloads": -1,
            "filename": "tanabesugano-1.4.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "493ed849467956100055f6bf022255d5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.1,<4.0",
            "size": 16705,
            "upload_time": "2023-12-20T12:21:46",
            "upload_time_iso_8601": "2023-12-20T12:21:46.152924Z",
            "url": "https://files.pythonhosted.org/packages/f0/6c/4cd61ef35f344f4dbf21abde944822a35c53de26062096439d3af179b83c/tanabesugano-1.4.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "32bbe25584872d17aa1ac62d3fc1b0a6fe53f684b761bbedcb3f01911918f0ac",
                "md5": "2c582003be4678e4f4c7f13b61fcfa38",
                "sha256": "4f99206e8aea9bb81efeb73721dd949f981f4e71ef98d9afe77332b971661665"
            },
            "downloads": -1,
            "filename": "tanabesugano-1.4.3.tar.gz",
            "has_sig": false,
            "md5_digest": "2c582003be4678e4f4c7f13b61fcfa38",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.1,<4.0",
            "size": 15147,
            "upload_time": "2023-12-20T12:21:47",
            "upload_time_iso_8601": "2023-12-20T12:21:47.519858Z",
            "url": "https://files.pythonhosted.org/packages/32/bb/e25584872d17aa1ac62d3fc1b0a6fe53f684b761bbedcb3f01911918f0ac/tanabesugano-1.4.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-20 12:21:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Anselmoo",
    "github_project": "TanabeSugano",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tanabesugano"
}
        
Elapsed time: 3.25998s