Skip to main content

A lightweight Python package for converting between fractional and Cartesian coordinates, supporting both forward and inverse transformations.

Project description

Frac-to-cart-coordinates

The Frac-to-cart-coordinates package allows users to easily convert atomic coordinates from Cartesian to fractional format and vice versa, based on the unit cell parameters.

Overview

In crystallography, atomic positions within a crystal's unit cell can be described using:

  • Fractional coordinates $(x/a, y/b, z/c)$, which refer to the natural axes (a, b, c), scaled by their respective unit cell lengths.
  • Orthogonal coordinates $(X, Y, Z)$, which use a right-angled Cartesian system with distances measured in Ångstroms.

For triclinic unit cells, the relationship between these coordinate systems involves a transformation matrix with non-trivial elements.

This implementation follows the methodology described on Jon Cooper's website, fractorth. It relies on the fundamental principles of spherical trigonometry (see implementation_details).

Installation

Run the following command in your terminal:

pip install Frac-to-cart-coordinates

Make sure you have numpy installed and Python 3.6 or higher.

Usage

Importing the Module

from Fractocart import convert_to_fractional_coordinates, convert_to_cartesian_coordinates

Functions

  1. Convert to Fractional Coordinates

    fractional_coords = convert_to_fractional_coordinates(cartesian_coords, unit_cell)
    
  2. Convert to Cartesian Coordinates

    cartesian_coords = convert_to_cartesian_coordinates(fractional_coords, unit_cell)
    

Contributing

Contributions are welcome! To contribute:

  1. Clone the repository.
  2. Create a feature branch (git checkout -b feature-name).
  3. Commit your changes (git commit -m "Add new feature").
  4. Push to the branch (git push origin feature-name).
  5. Open a merge request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

Frac-to-cart-coordinates-1.1.2.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

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

Frac_to_cart_coordinates-1.1.2-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file Frac-to-cart-coordinates-1.1.2.tar.gz.

File metadata

File hashes

Hashes for Frac-to-cart-coordinates-1.1.2.tar.gz
Algorithm Hash digest
SHA256 5079f42ad3fe7d9413216dd6e80e49cebcdb9397016c55f6cf1ef7278741dfb5
MD5 91c1b45dceac766c26aaae4d3cb8f1d9
BLAKE2b-256 6f9c1aa5908b1419fb031a7fb20acfd8d99f21fec5910876d0c54197dac4bb0a

See more details on using hashes here.

File details

Details for the file Frac_to_cart_coordinates-1.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for Frac_to_cart_coordinates-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4f8a44f04e651ce93daeae4774abfeef9a806c39660d08b0d677381ccab6f953
MD5 e112441ee5902dfceca15b9ab6f0e07d
BLAKE2b-256 f8aa366e120baeee437ac3d41817418007c84cf8e69d94463d54d947b04edd3b

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