Skip to main content

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!

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

spirit-extras-0.0.35.tar.gz (46.0 kB view details)

Uploaded Source

Built Distribution

spirit_extras-0.0.35-py3-none-any.whl (41.4 kB view details)

Uploaded Python 3

File details

Details for the file spirit-extras-0.0.35.tar.gz.

File metadata

  • Download URL: spirit-extras-0.0.35.tar.gz
  • Upload date:
  • Size: 46.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for spirit-extras-0.0.35.tar.gz
Algorithm Hash digest
SHA256 c8536125a133a2b8f97b6fc1832fe4d40576b35ca276a46c1757b5a44a24f954
MD5 2e7030b15cc34e7e69726a20c8b936e8
BLAKE2b-256 1dba409a1b0bb7f763d2480a5e12d269bccc623afc4afbc228052bfe310b83ba

See more details on using hashes here.

File details

Details for the file spirit_extras-0.0.35-py3-none-any.whl.

File metadata

File hashes

Hashes for spirit_extras-0.0.35-py3-none-any.whl
Algorithm Hash digest
SHA256 9c6b34fba900f87d054a77ba97875ca878f5b7fdcd25c8b81590b5d598caf550
MD5 867bc0398d813be782747738f169f90c
BLAKE2b-256 8693ca47a70de09e68a44f4e148693b8616b2759f24aab737118534c743bc226

See more details on using hashes here.

Supported by

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