Skip to main content

gyroid is a python package that generates symmetry adapted basis functions based on the space group of a unit cell.

Quickstart

1. Install

$ easy_install gyroid

or

$ tar -xvf gyroid-xxx.tar.gz
$ cd gyroid-xxx
$ python setup.py install

Required packages:

  • numpy: it should be installed before installing gyroid.

  • scipy: use it to save data in Matlab mat format.

  • matplotlib: 2D Graphic plotting.

  • mayavi: it depends on many packages, e.g. VTK (compiled with python wrapper and shared library on). If you do not need the render_structure_3d functionality, simply ignore it.

2. Usage

Following is a typical usange of the package. It will produce a set of SABFs with point group Ia-3d (#230) in a cubic unit cell. The last line will syntheses a gyroid structure with all coefficients for SABF equal to 1.0, save the structure data into a Matlab mat file, show a screenshot of the rendered image and save the image in a file.

>>> import gyroid as gy
>>> import numpy as np
>>> N1,N2,N3 = 32,32,32
number of grids in each dimension of a unit cell
>>> uc = gy.UnitCell(3)
create a standard cubic unit cell with side length 1.0
>>> group = gy.Group(3,gy.BRAVAIS,uc.shape,"Ia-3d")
create a Ia-3d point group
>>> grid = gy.Grid(np.array([N1,N2,N3]),group)
create a collection of waves that are not canceled
>>> basis = gy.Basis(group,grid)
create the SABFs
>>> gy.render_structure_3d(basis,grid,N1,N2,N3,1.0)
create the gyroid structure and render it

Ask for Help

Metadata

Release files for gyroid 0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gyroid 0.4
File Size Uploaded Provenance
gyroid-0.4.tar.gz 316.8 kB Without provenance Details

Release files / gyroid-0.4.tar.gz

Download URL gyroid-0.4.tar.gz
Size 316.8 kB
Tags Source
SHA-256 checksum
How to use checksums
6c7a42c5baa82ebe822487b704bad7f1f6b56a7eb123298e14b05bba3e6ff274
BLAKE2b-256 checksum
How to use checksums
617b65a3beb965b434d3003bdc218b9cd2418b21aa003343419306e79ca9bfb2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for gyroid 0.4

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page