Skip to main content

A Curated Dataset of Crystal Structures and Experimentally Measured Ionic Conductivities for Lithium Solid-State Electrolytes

Project description

OBELiX: An Experimental Ionic Conductivity Dataset

OBELiX (Open solid Battery Electrolytes with Li: an eXperimental dataset) is a dataset of 599 synthesized solid electrolyte materials and their experimentally measured room temperature ionic conductivity along with descriptors of their space group, lattice parameters, and chemical composition. It contains full crystallographic description in the form of CIF files for 321 entries.

A full description an analysis can be found in our paper. The dataset is also available on Kaggle.

Files Download

File Links
Train Dataset xlsx, csv
Train CIF files zip, tar.gz
Test Dataset xlsx, csv
Test CIF files zip, tar.gz
Full Dataset xlsx, csv
All CIF files zip, tar.gz

Python API

Installation

pip install obelix-data

Examples

Print the composition and ionic conductivity of the first entry

from obelix import OBELiX

ob = OBELiX()

print(f"The ionic conductivity of {ob[0]['Reduced Composition']} is {ob[0]['Ionic conductivity (S cm-1)']}")

Print all the labels and IDs:

print("Column labels:", ob.labels)
print("Entry IDs:", ob.entries)

Use the entry ID to get information about it

print(f"The ID of the first entry is {ob.entries[0]}")

print(f"The ionic conductivity of {ob['jqc']['Reduced Composition']} is {ob['jqc']['Ionic conductivity (S cm-1)']}")

Plot the distribution of ionic conductivities in the train set:

import numpy as np
import matplotlib.pyplot as plt

np.log10(ob.train_dataset.dataframe["Ionic conductivity (S cm-1)"]).plot.hist()
plt.show()

Print the entries in the test dataset that have a CIF file:

print(ob.test_dataset.with_cifs().entries)

Round partial occupancies of all CIF files and save them in a folder named np_cifs

from pathlib import Path

output_path = "np_cifs"
output_path.mkdir(exist_ok=True)

for entry in ob.round_partial().with_cifs():
    entry["structure"].to(output_path+entry["ID"]+".cif")

Labels and Features

Name Definition
ID Entry identifier, a three symbols alphanumeric string
Reduced Composition Chemical formula of the material
Z Number of formula units in the unit cell
True Composition Composition of the unit cell
Ionic conductivity (S cm-1) Experimental ionic conductivity in Siemens per centimeter. It is the total ionic conductivity when both are reported
IC (Total) Total ionic conductivity in S/cm
IC (Bulk) Bulk Ionic conductivity in S/cm, if both total and bulk are blank, it is assumed that the reported conductivity is the total IC
Space group Space group Hermann–Mauguin notation short name
Space group # Space group number
a, b, c, alpha, beta, gamma Lattice parameters
Family Crystal family
DOI Digital object identifier of the original experimental publication from which this IC measurement was taken
Checked (OUTDATED) Weather entries was manually checked
Ref (OUTDATED, see Laskowski ID and Liion ID instead)) Reference from which data was taken from D1=Liion, D2=Laskowski
Cif ID Whether the entry has a cif or not. This field will read "done" when it does and will be empty otherwise
Cif ref_1, Cif ref_2 (OUTDATED, see ICSD ID) Notes of where to find the CIF information if available
note Notes and comments about the entry
close match Whether the cif file comes from a closely matching structure or from the actual publication (DOI). If a close match this field will read "Yes"
close match DOI Digital object identifier of the publication from which the CIF was taken
ICSD ID Inorganic Crystal Structure Database ID of the structure if it can be found in that database
Laskowski ID Reference (citation) number in the pdf supplementary information of Forrest A. L. Laskowski et al., Energy Environ. Sci., 16, 1264 (2023) if the entry is also in that database. Entries are not numbered so it is easier to identify them that way. Multiple entries can come from the same reference; use the composition to identify the exact entry.
Liion ID Entry number in the The Liverpool Ionics Dataset if the entry is also in that database

Citation

If you use OBELiX, please cite our paper

@article{therrien2025obelix,
  title   = {OBELiX: A Curated Dataset of Crystal Structures and Experimentally Measured Ionic Conductivities for Lithium Solid-State Electrolytes},
  author  = {Félix Therrien and Jamal Abou Haibeh and Divya Sharma and Rhiannon Hendley and Alex Hernández-García and Sun Sun and Alain Tchagang and Jiang Su and Samuel Huberman and Yoshua Bengio and Hongyu Guo and Homin Shin},
  year    = {2025},
  journal = {arXiv preprint arXiv: 2502.14234}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obelix_data-1.2.0.tar.gz (9.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

obelix_data-1.2.0-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file obelix_data-1.2.0.tar.gz.

File metadata

  • Download URL: obelix_data-1.2.0.tar.gz
  • Upload date:
  • Size: 9.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for obelix_data-1.2.0.tar.gz
Algorithm Hash digest
SHA256 d62fbff470c925ac8cd07ac34cc854ad35fafb895777146ced847d31ec7a1a56
MD5 6986257d43fb5873a2a77500ac8bb9e0
BLAKE2b-256 3c04baba3b1608b28f502e6eabfc41402e1c79ff8f751afb43fd661e8fa33c18

See more details on using hashes here.

Provenance

The following attestation bundles were made for obelix_data-1.2.0.tar.gz:

Publisher: python-publish.yml on NRC-Mila/OBELiX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file obelix_data-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: obelix_data-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for obelix_data-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 776d47d46e545be63502130d484b1aa17abd1b1c742b277d15c0a2c128f70afd
MD5 26024de2bcebdd84dd9b65ea8c3e5896
BLAKE2b-256 011dc5a7fb850e33b527d5e6bc14b7c34be311005445d794d97c40ced36f5f58

See more details on using hashes here.

Provenance

The following attestation bundles were made for obelix_data-1.2.0-py3-none-any.whl:

Publisher: python-publish.yml on NRC-Mila/OBELiX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page