Skip to main content

ions_logo

Contents

About

ions is a python library made for studying crystalline ionic conductors

Installation

pip install ions

or

git clone https://github.com/dembart/ions
cd ions
pip install .

Minimal usage examples:

Note: The last library update was not systematically tested. Errors are expected. Be careful.

Inequivalent ionic jumps (edges) forming a percolating network

from ase.io import read
from ions import Percolator

file = '/Users/artemdembitskiy/Downloads/LiFePO4.cif'
atoms = read(file)  

pl = Percolator(atoms, mobile_specie='Li', upper_bound=5.0)

bottleneck_radius = 0.5 
mincut, maxdim = pl.mincut_maxdim(bottleneck_radius)
print(f'Maximum percolation dimensionality: {maxdim}')
print(f'Jump distance cutoff: {mincut} angstrom', '\n')

edges = pl.unique_edges(mincut, bottleneck_radius, method = 'naive')
print(f'Inequivalent edges forming {maxdim}D percolating network:')
print(edges)
Maximum percolation dimensionality: 2
Jump distance cutoff: 4.755859375 angstrom 

Inequivalent edges forming 2D percolating network:
[[ 0  3  0 -1  0]
 [ 0  0 -1  0  0]]

Notebooks

How to cite

If you use the library consider citing the following paper:

@article{dembitskiy2025benchmarking,
  title={Benchmarking machine learning models for predicting lithium ion migration},
  author={Dembitskiy, Artem D and Humonen, Innokentiy S and Eremin, Roman A and Aksyonov, Dmitry A and Fedotov, Stanislav S and Budennyy, Semen A},
  journal={npj Computational Materials},
  volume={11},
  number={1},
  pages={131},
  year={2025},
  publisher={Nature Publishing Group UK London}
}

Release files for ions 0.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ions 0.5.1
File Size Uploaded
ions-0.5.1.tar.gz 133.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ions 0.5.1
File Interpreter ABI Platform
ions-0.5.1-py3-none-any.whl Python 3 none any Details

Total release size:270.4 kB

Release files / ions-0.5.1.tar.gz

Download URL ions-0.5.1.tar.gz
Size 133.0 kB
Tags Source
SHA-256 checksum
How to use checksums
64ff7793d09498742c2acbdc64e60cce1d49d1ac6d686e45dfe918e412596378
BLAKE2b-256 checksum
How to use checksums
b5116456c2449b2ff79283360c63f6ad238d429259e428588518676ac2e51d68
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.66.2 CPython/3.8.8

Release files / ions-0.5.1-py3-none-any.whl

Download URL ions-0.5.1-py3-none-any.whl
Size 137.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
411c9c54c62ccd7e47cab484c3ef5812f4b0b0ee63c92a28cad1c1719088bf39
BLAKE2b-256 checksum
How to use checksums
54f0eb31a9fa036ba53b8e9d4f02f5c68d218ed5d074a2d4fb3a94ef32a231ef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.66.2 CPython/3.8.8

Release history Release notifications | RSS feed

This release

0.5.1 This release

2 release files

0.5

2 release files

0.4.1

2 release files

0.4

2 release files

0.3.5

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page