Skip to main content

Library to draw the pyrochlore lattice and configurations of the Spin Ice model

Project description

Overview

Library based on matplotlib (>=3.3) to draw the pyrochlore lattice (corner-sharing tetrahedra) and configurations of the Spin Ice model.

Installation

$ pip install pyrodraw

Basic usage

It can, and probably should, be executed as a script:

python -m pyrodraw [<parameters>...]

and follow the instructions which appear on the screen.

Depending on the parameters supplied:

  • No arguments: draws only the pyrochlore lattices and adds details such as names to the axes.
  • '+ z': draws the spin ice +z configuration.
  • 'ms': draws the saturation configuration with the field at [111], with positives simple monopoles in all Up Tetrahedra.
  • 'md': draws the configuration with positive double monopoles in all Up Tetrahedra.
  • Name of a file along with a column number: the data is obtained from it to draw the configuration.

It's also possible to import it and use it to draw more specific configurations.

Possible general improvements

The following are things I didn't know how to do it properly by the time I built the library, and for the purpose of the project it didn't worth changing them when I published it.

  • The documentation is not properly done (doesn't follow a docstring convention), and it's in spanish.
  • It probably should use argparse for managing the arguments.

ToDo

  • Add a circle path as a bottom lid for the arrows.
  • Be possible to annotate the field direction when using the field arrow.

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

pyrodraw-2.0.0.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

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

pyrodraw-2.0.0-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

Details for the file pyrodraw-2.0.0.tar.gz.

File metadata

  • Download URL: pyrodraw-2.0.0.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.2 Linux/5.4.0-1040-azure

File hashes

Hashes for pyrodraw-2.0.0.tar.gz
Algorithm Hash digest
SHA256 2ab8f81c94aaba9b9b1a1782f58caf0fcb77150941584a94945123fce9df6451
MD5 da3c3b3285debc06092d02680de9ccf2
BLAKE2b-256 d5c2ad4eefaa871e24004ad6f49d0245ae59e6aa8ad630800483e3adf827dba0

See more details on using hashes here.

File details

Details for the file pyrodraw-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: pyrodraw-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 20.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.2 Linux/5.4.0-1040-azure

File hashes

Hashes for pyrodraw-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 336a0f512c3518b74b54bc5fe7f0ed47fc69691944ee22d9090231fc57fa1e5e
MD5 04fc6b014e0ddbf04758377d14a034e1
BLAKE2b-256 c855157b80c3cadeb4b8521ad692316d8c23e16eeaade0830eae6e3a78adfcf9

See more details on using hashes here.

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