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. Fork the repository, then clone the fork (see there).
  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.6.tar.gz (5.1 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.6-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for Frac-to-cart-coordinates-1.1.6.tar.gz
Algorithm Hash digest
SHA256 c81d731f2ee35eac4675b9ca947c475950265497e5ca80a3554b573e014aad3c
MD5 479127c82c920e9936df40d9e3b13415
BLAKE2b-256 609ffbe275e136c4eee7474abb4c260d197ba2e0cec45a02de5147ab0c2afc73

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Frac_to_cart_coordinates-1.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e19cf409e50f3558ed590fe13d6094920ea67518b5b4dd737b3fa1041b97a2a1
MD5 75788b24fe0c9e646f124e63d6c0f55d
BLAKE2b-256 93d39b86aa67c19734809837743580af2d752137b4f83b94d3d93ffe80684f82

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