Skip to main content

Spinney: a Python package for assisting with first-principles simulations of point defects in solids.

Project description


Spinney is a software package developed in order to assist with first-principles investigations of point defects in solids within the supercell approach. For this purpose, several tools able to aid in the various steps associated with this kind of studies are implemented.

Some of the tasks that Spinney is able to perform are:

  • Compute, from external data (taken for example from online repositories), the ranges of validity for the elements chemical potentials according to thermodynamic constraints;
  • Calculate the correction energy due to electrostatic finite-size-effects in charged supercells;
  • Calculate defect formation energies and transition levels;
  • Calculate defects and carriers concentrations.

Spinney is written in Python and offers a very general and flexible user interface which can be easily integrated with any first-principles code.


The easiest way to install Spinney is through pip:

pip install spinney

We suggest to create a virtual environment in which the Spinney code can be installed.

The requirement for a successful installation are:


Spinney does not support newer versions of ASE.


Project details

Download files

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

Files for Spinney, version 0.7a5
Filename, size File type Python version Upload date Hashes
Filename, size Spinney-0.7a5-py3-none-any.whl (1.6 MB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size Spinney-0.7a5.tar.gz (1.5 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page