macchiato


Namemacchiato JSON
Version 0.1.1 PyPI version JSON
download
home_page
SummaryData-driven nearest neighbor models for predicting experimental results on silicon lithium-ion battery anodes.
upload_time2023-12-12 02:10:08
maintainer
docs_urlNone
author
requires_python
licenseMIT License Copyright (c) 2023 Francisco Fernandez 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.
keywords data-driven-model nearest-neighbors clustering
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # macchiato

[![macchiatos CI](https://github.com/fernandezfran/macchiato/actions/workflows/CI.yml/badge.svg)](https://github.com/fernandezfran/macchiato/actions/workflows/CI.yml)
[![documentation status](https://readthedocs.org/projects/macchiato/badge/?version=latest)](https://macchiato.readthedocs.io/en/latest/?badge=latest)
[![pypi version](https://img.shields.io/pypi/v/macchiato)](https://pypi.org/project/macchiato/)
[![python version](https://img.shields.io/badge/python-3.8%2B-4584b6)](https://www.python.org/)
[![mit license](https://img.shields.io/badge/License-MIT-ffde57)](https://github.com/fernandezfran/macchiato/blob/main/LICENSE)
[![PRB](https://img.shields.io/badge/PhysRevB-108.144201-b31033)](https://doi.org/10.1103/PhysRevB.108.144201)

Data-driven nearest neighbor models for predicting experimental results on 
silicon lithium-ion battery anodes.

## Requirements

You need Python 3.8+ to run macchiato.


## Installation

You can install the most recent stable release of macchiato with 
[pip](https://pip.pypa.io/en/latest/)

```
python -m pip install -U pip
python -m pip install -U macchiato
```


## Usage

The Jupyter Notebook pipeline in the 
[paper folder](https://github.com/fernandezfran/macchiato/tree/main/paper) 
is presented to reproduce the results of the published article.


## Citation

> Fernandez, F., Otero, M., Oviedo, M. B., Barraco, D. E., Paz, S. A., & Leiva, 
> E. P. M. (2023). NMR, x-ray, and Mössbauer results for amorphous Li-Si alloys 
> using density functional tight-binding method. Physical Review B, 108(14), 144201. 

BibTeX entry:

```bibtex
@article{fernandez2023nmr,
  title={NMR, x-ray, and M{\"o}ssbauer results for amorphous Li-Si alloys using density functional tight-binding method},
  author={Fernandez, F and Otero, M and Oviedo, MB and Barraco, DE and Paz, SA and Leiva, EPM},
  journal={Physical Review B},
  volume={108},
  number={14},
  pages={144201},
  year={2023},
  publisher={APS}
}
```


## Contact

You can contact me if you have any questions at <ffernandev@gmail.com>

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "macchiato",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "data-driven-model,nearest-neighbors,clustering",
    "author": "",
    "author_email": "Francisco Fernandez <ffernandev@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/6d/2d/8d1d2a9bb68d0d4bbd3de11963c03f7e960889341567b64fee8eb33920d2/macchiato-0.1.1.tar.gz",
    "platform": null,
    "description": "# macchiato\n\n[![macchiatos CI](https://github.com/fernandezfran/macchiato/actions/workflows/CI.yml/badge.svg)](https://github.com/fernandezfran/macchiato/actions/workflows/CI.yml)\n[![documentation status](https://readthedocs.org/projects/macchiato/badge/?version=latest)](https://macchiato.readthedocs.io/en/latest/?badge=latest)\n[![pypi version](https://img.shields.io/pypi/v/macchiato)](https://pypi.org/project/macchiato/)\n[![python version](https://img.shields.io/badge/python-3.8%2B-4584b6)](https://www.python.org/)\n[![mit license](https://img.shields.io/badge/License-MIT-ffde57)](https://github.com/fernandezfran/macchiato/blob/main/LICENSE)\n[![PRB](https://img.shields.io/badge/PhysRevB-108.144201-b31033)](https://doi.org/10.1103/PhysRevB.108.144201)\n\nData-driven nearest neighbor models for predicting experimental results on \nsilicon lithium-ion battery anodes.\n\n## Requirements\n\nYou need Python 3.8+ to run macchiato.\n\n\n## Installation\n\nYou can install the most recent stable release of macchiato with \n[pip](https://pip.pypa.io/en/latest/)\n\n```\npython -m pip install -U pip\npython -m pip install -U macchiato\n```\n\n\n## Usage\n\nThe Jupyter Notebook pipeline in the \n[paper folder](https://github.com/fernandezfran/macchiato/tree/main/paper) \nis presented to reproduce the results of the published article.\n\n\n## Citation\n\n> Fernandez, F., Otero, M., Oviedo, M. B., Barraco, D. E., Paz, S. A., & Leiva, \n> E. P. M. (2023). NMR, x-ray, and M\u00f6ssbauer results for amorphous Li-Si alloys \n> using density functional tight-binding method. Physical Review B, 108(14), 144201. \n\nBibTeX entry:\n\n```bibtex\n@article{fernandez2023nmr,\n  title={NMR, x-ray, and M{\\\"o}ssbauer results for amorphous Li-Si alloys using density functional tight-binding method},\n  author={Fernandez, F and Otero, M and Oviedo, MB and Barraco, DE and Paz, SA and Leiva, EPM},\n  journal={Physical Review B},\n  volume={108},\n  number={14},\n  pages={144201},\n  year={2023},\n  publisher={APS}\n}\n```\n\n\n## Contact\n\nYou can contact me if you have any questions at <ffernandev@gmail.com>\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Francisco Fernandez  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. ",
    "summary": "Data-driven nearest neighbor models for predicting experimental results on silicon lithium-ion battery anodes.",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/fernandezfran/macchiato"
    },
    "split_keywords": [
        "data-driven-model",
        "nearest-neighbors",
        "clustering"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d8ecb445dd072f38228fda81d109a52e98496b9b0b91b4589396ed5859712559",
                "md5": "5cdf0f9496840ad935291073d221eb8f",
                "sha256": "b35ec46e448c949d2802b2a149758bbe7467c82aafe624607239cad807139792"
            },
            "downloads": -1,
            "filename": "macchiato-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5cdf0f9496840ad935291073d221eb8f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 15547,
            "upload_time": "2023-12-12T02:10:06",
            "upload_time_iso_8601": "2023-12-12T02:10:06.930642Z",
            "url": "https://files.pythonhosted.org/packages/d8/ec/b445dd072f38228fda81d109a52e98496b9b0b91b4589396ed5859712559/macchiato-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6d2d8d1d2a9bb68d0d4bbd3de11963c03f7e960889341567b64fee8eb33920d2",
                "md5": "64f2af1742d49e2039572d1197f60efe",
                "sha256": "d022c6a1b86835b244892072a4787c566d2c1cbb9916731c0fa080878aa1a634"
            },
            "downloads": -1,
            "filename": "macchiato-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "64f2af1742d49e2039572d1197f60efe",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 12147,
            "upload_time": "2023-12-12T02:10:08",
            "upload_time_iso_8601": "2023-12-12T02:10:08.745257Z",
            "url": "https://files.pythonhosted.org/packages/6d/2d/8d1d2a9bb68d0d4bbd3de11963c03f7e960889341567b64fee8eb33920d2/macchiato-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-12 02:10:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fernandezfran",
    "github_project": "macchiato",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "macchiato"
}
        
Elapsed time: 0.18163s