Framework for random structure search using polynomial machine learning potentials
rsspolymlp is a Python code designed to conduct random structure searches (RSS) using polynomial machine learning potentials (MLPs).
The code provides functionalities for generating initial random structures, performing geometry optimization using polynomial MLPs, and eliminating duplicate structures.
The formulation and development of polynomial MLPs are detailed in pypolymlp.
Installation
Required libraries and python modules
- python >= 3.10
- scikit-learn
- joblib
- pypolymlp
- spglib
- symfc
[Optional]
- matplotlib, seaborn
- pymatgen
How to install
- Install from conda-forge
| Name | Downloads | Version | Platforms |
|---|---|---|---|
conda create -n rsspolymlp
conda activate rsspolymlp
conda install -c conda-forge rsspolymlp
- Install from PyPI
conda create -n rsspolymlp
conda activate rsspolymlp
conda install -c conda-forge scikit-learn joblib pypolymlp spglib symfc
pip install rsspolymlp
How to use rsspolymlp
- Workflow of RSS with polynomial MLPs
- Initial structure generation
- Global RSS with polynomial MLPs
- Unique structure identification and RSS result summarization
- Phase stability analysis
- Development kit for polynomial MLPs
- MLP dataset generation
- DFT dataset division
- Polynomial MLP development
- Pareto-optimal MLP selection
- Python API
- RSS workflow
- VASP calculation utilities
- Single-point calculation
- Local geometry optimization
- Matplotlib utilities
Citation of rsspolymlp
If you use rsspolymlp in your study, please cite the following articles.
“Systematic global structure search of bismuth-based binary systems under pressure using machine learning potentials”, Phys. Rev. Materials 10, 093801 (2026)
@article{Phys.Rev.Mater.10.093801,
title = {Systematic global structure search of bismuth-based binary systems under pressure using machine learning potentials},
author = {Wakai, Hayato and Ishiwata, Shintaro and Seko, Atsuto},
journal = {Phys. Rev. Mater.},
volume = {10},
issue = {9},
pages = {093801},
numpages = {28},
year = {2026},
month = {Sep},
publisher = {American Physical Society},
doi = {10.1103/k9sg-v7hl},
url = {https://link.aps.org/doi/10.1103/k9sg-v7hl}
}
Metadata
Release files for rsspolymlp 0.4.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rsspolymlp-0.4.3.tar.gz | 92.6 kB | Without provenance | Details for rsspolymlp-0.4.3.tar.gz |
Release files / rsspolymlp-0.4.3.tar.gz
| Download URL | rsspolymlp-0.4.3.tar.gz |
|---|---|
| Size | 92.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5e5c314f76a4ceb8af8b743c079911ee12ecdbd78d6bf42ca2c7902fd4aa6b62
|
|
BLAKE2b-256 checksum How to use checksums |
9dd0026595c12097de69bf41d978edee8e125a6ab3025ab44424ee4b06096ccf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for rsspolymlp 0.4.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.