Metadata-Version: 2.1
Name: solid-state
Version: 0.1
Summary: The library for studying key properties of solid-state battery materials.
Home-page: https://github.com/cmg-storion/solid_state
Author: Artem Dembitskiy
Author-email: art.dembitskiy@gmail.com
License: MIT
Keywords: solid-state,electorlyte,batteries,Li-ion
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: tqdm
Requires-Dist: mp-api
Requires-Dist: pymatgen
Requires-Dist: ase
Requires-Dist: ions (>=0.5.1)

## Contents
- [About](#about)
- [Installation](#installation)
- [Examples](#examples)


### About

The Python library and a collection of examples and utilities leveraging Python packages (ASE, pymatgen, etc.) to study key properties of solid-state battery materials.

### Installation

```
git clone https://github.com/cmg-storion/solid-state
cd solid-state
pip install .
```

### Examples

- [UMLIP-NEB percolation analysis](examples/umlip_neb_percolation_analysis.ipynb)
- [Li|Anode coating|Electrolyte|Cathode sandwich stability](examples/sandwich_stability.ipynb) (using only the Materials Project's entries)
- [High-throughput pipeline for screening the MP database](examples/workflow_MP.ipynb)




