Skip to main content

The LatticeFinder Program

PyPI - Python Version GitHub release (latest by date) PyPI Conda Documentation Binder Licence LGTM Grade

Authors: Geoffrey R. Weal and Dr. Anna L. Garden (University of Otago, Dunedin, New Zealand)

Group page: https://blogs.otago.ac.nz/annagarden/

What is LatticeFinder

LatticeFinder is designed to give you the optimum lattice constants for a 3D system.

Try LatticeFinder before you Clone/Pip/Conda (on Binder/Jupter Notebooks)!

If you are new to the LatticeFinder program, it is recommended try it out by running LatticeFinder live on our interactive Jupyter+Binder page before you download it. On Jupyter+Binder, you can play around with the LatticeFinder program on the web. You do not need to install anything to try LatticeFinder out on Jupyter+Binder.

Click the Binder button below to try LatticeFinder out on the web! (The Binder page may load quickly or may take 1 or 2 minutes to load)

Binder

Have fun!

Installation

It is recommended to read the installation page before using the LatticeFinder program.

latticefinder.readthedocs.io/en/latest/Installation.html

Note that you can install LatticeFinder through pip3 and conda.

Output files that are created by LatticeFinder

The LatticeFinder program is designed to give the information that you can use to determine the optimise value of the lattice constant for your system. For example, for a Au face centred cubic (FCC) lattice you can first perform an broad overlook of the energy per atom for various lattice constants.

You can then add more lattice constant measurements around the point where you believe the lowest energy form of the Au FCC lattice resides

The data of the energies of all FCC lattices for various lattice constants are also given, as well as other final details about the optimum system, such as the stress tensor and bulk modulus.

Symbol: Au
Lattice_type: FaceCenteredCubic
calculator: <asap.RGL object at 0x0x2fcab40>
size: (16, 16, 16)
directions: []
miller: []
Lattice Constant Parameters: ['c']

Properties of System: 

Total energy: -62721.105237252974 eV
No. of atoms: 16384 Atoms (Note the number of atoms along each natural direction of the bulk is (16, 16, 16))
Cohesive energy: -3.8281924583284286 eV/Atom

Total Volume: 275741.9107614719 Angstroms^3
Volume per atom: 16.829950607999994 Angstroms^3/Atom

Stress tensor:
[[-3.97161678e-04  1.47073761e-19  4.09156132e-19]
 [ 1.47073761e-19 -3.97161678e-04  1.36259282e-19]
 [ 4.09156132e-19  1.36259282e-19 -3.97161678e-04]]

Bulk Modulus: 184.94027058847462 GPa

This program is designed to help obtain the optimal lattice constants for systems that contain more than one lattice constant. For example, for a Au hexagonal close packed (HCP) you will obtain the following plots:

Where can I find the documentation for LatticeFinder

All the information about this program is found online at latticefinder.readthedocs.io/en/latest/. Click the button below to also see the documentation:

Documentation

About

Python PyPI - Python Version
Repositories GitHub release (latest by date) PyPI Conda
Documentation Documentation Binder
Tests LGTM Grade
License Licence
Authors Geoffrey R. Weal, Dr. Anna L. Garden
Group Website https://blogs.otago.ac.nz/annagarden/

Metadata

Release files for LatticeFinder 1.1.2.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 LatticeFinder 1.1.2.4
File Size Uploaded Provenance
LatticeFinder-1.1.2.4.tar.gz 32.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for LatticeFinder 1.1.2.4
File Interpreter ABI Platform
LatticeFinder-1.1.2.4-py3-none-any.whl Python 3 none any Details

Total release size: 70.1 kB

Release files / LatticeFinder-1.1.2.4.tar.gz

Download URL LatticeFinder-1.1.2.4.tar.gz
Size 32.3 kB
Tags Source
SHA-256 checksum
How to use checksums
10e3faaaa95bc8a6e1c5d976a7d1688daf2281e6c44cc026e4b356ccfdce602f
BLAKE2b-256 checksum
How to use checksums
7ed94fd7249069a84b72a5783fa2503989ff7852b867033b58a4fff22e0c03d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

Release files / LatticeFinder-1.1.2.4-py3-none-any.whl

Download URL LatticeFinder-1.1.2.4-py3-none-any.whl
Size 37.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ea2aa22cb3cfb69d6cb2c21ce1a1458201804d8d4baf5795f6735e73404adbee
BLAKE2b-256 checksum
How to use checksums
4c2228ca49101e98741160b4dff58182dc84dcb768a55bf239f1f0f5dda2bb8a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

Security for LatticeFinder 1.1.2.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.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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