Package to be used with the magnetism simulation tool spirit
Project description
spirit-extras
Package with some useful scripts, to be used together with the Spirit python API (github.com/spirit-code/spirit/).
Data structure for spin systems
Parse data from a Spirit state pointer
from spirit import state
import spirit_extras.data
with state.State("input.cfg") as p_state:
spin_sytem = spirit_extras.data.spin_system_from_p_state()
# Information about the bravais lattice is automatically parsed from the spirit API
print(spin_system)
# The spins can be set
ib, a, b, c = 1, 5, 3, 4
idx = spin_system.idx(ib, a, b, c) # computes the linear index from a bravais tupel
spin_system.spins[idx] = [0,0,-1]
ib, a, b, c = spin_system.tupel(5) # computes the bravais tupel from a linear index
# A shaped view into the spin system is also available
spin_system.shaped().spins[ib,a,b,c] = [0,0,1]
# Slicing syntax works
spin_system.shaped().spins[ib,:,b,c] = [0,1,0]
mask = np.linalg.norm(spin_system.positions - spin_system.center() < 5, radius=1)
spin_sytem.spins[mask] = [1,0,0]
Create from your own buffers
# Since spirit_extras.Spin_System is needed for many functions in spirit_extras, it can also be created from a spins and positions arrays
spins = [ [1,0,0] for i in range(10) ]
# The default behaviour is to expect an unordered system, meaning some functions will throw an exception
my_spin_system = spirit_extras.data.Spin_System(positions=None, spins=spins) # positions dont _have_ to be specified
try:
my_spin_sytem.shaped() # needs an ordered system
except:
print("Throws :(")
# To create an ordered system pass `unordered=False` and specify `n_cells`
my_spin_system = spirit_extras.data.Spin_System(positions=None, spins=spins, n_cells=[10,1,1], unordered=False)
my_spin_sytem.shaped() # works!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
spirit-extras-0.0.31.tar.gz
(45.7 kB
view details)
Built Distribution
File details
Details for the file spirit-extras-0.0.31.tar.gz.
File metadata
- Download URL: spirit-extras-0.0.31.tar.gz
- Upload date:
- Size: 45.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 95092fabc8b1b5692e1a78620b47e55ad7b90ac9a807eedc53e7d7346a980ded |
|
| MD5 | 3e7711e0e7aa4d665efd8459c03550e1 |
|
| BLAKE2b-256 | 861a821e83c3e981e1185b9fb8cb50d59faeab94f08e7ed04f3d0921e6753cb0 |
File details
Details for the file spirit_extras-0.0.31-py3-none-any.whl.
File metadata
- Download URL: spirit_extras-0.0.31-py3-none-any.whl
- Upload date:
- Size: 41.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4c01c5cdfa08262b34441ed46c73e7b7cc28af412429dd3b5851c46b8954d5af |
|
| MD5 | 43af4d911512866d95557a3d4ca62030 |
|
| BLAKE2b-256 | f59a215c013cc699f2159441c0f89153a9dadd82a7642d37da5773270270de0f |
