Skip to main content

Tools for analyzing Scanning X-ray Diffraction Microscopy data

Project description

https://github.com/WilliamJudge94/sxdm/actions/workflows/python-package-conda.yml/badge.svg Documentation status https://badge.fury.io/py/sxdm.svg

SXDM is a library for analyzing Scanning X-Ray Diffraction Microscopy data for materials science, chemistry and similar fields. The major focus is on Scanning Microscopy frames collected at multiple incident angles. One can import, retrieve, and analyze 26 - ID - C datasets, including X-ray Fluorescence data, all from a Python format.

Motivation & Features

  • Importing and analysis of scanning x-ray diffraction microscopy framesets

  • Analysis of scanning x-ray diffraction microscopy (centroids, region of interest, and general user analysis)

  • Provide a python toolkit for analysis of X-ray diffraction frames.

  • Privide a python toolkit for importing and retrieving X-ray Fluorescence data.

  • Store data in an open format for easy distribution.

  • Provide framework 26-ID-C data handling.

Installation (pip)

  • pip install sxdm

Developer Installation (git)

  • conda create -n sxdm python=3.6

  • source activate sxdm

  • git clone clone git@github.com:WilliamJudge94/sxdm.git

  • pip3 install -r sxdm/requirements.txt

  • pip3 install ipykernel

  • ipython kernel install –user –name=sxdm

Developer Virtual Environment & Jupyter Setup (git)

Run Commands In Jupyter Shell

  • %matplotlib qt

  • import sys

Linux - sys.path.append(‘/path/to/sxdm/folder’)

MacOS - sys.path.append(‘/Users/usr/virtual_environment/lib/python3.7/site-packages/’)

  • from sxdm import *

Usage

Please see the https://sxdm.readthedocs.io/en/latest/ for more details

License

This project is released under the GNU General Public License version 3.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 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

sxdm-1.0.0.tar.gz (6.4 MB view details)

Uploaded Source

Built Distribution

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

sxdm-1.0.0-py3-none-any.whl (92.7 kB view details)

Uploaded Python 3

File details

Details for the file sxdm-1.0.0.tar.gz.

File metadata

  • Download URL: sxdm-1.0.0.tar.gz
  • Upload date:
  • Size: 6.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.6.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.19.5 CPython/3.8.5

File hashes

Hashes for sxdm-1.0.0.tar.gz
Algorithm Hash digest
SHA256 559940c2df614806b704825381a07887c845efe3b94ce70b1b2b7dba95f1012e
MD5 be0fa94686fd7da4c68a370d1028fe52
BLAKE2b-256 a6d7b6acf764f12f59f098d33cb5c66f05b1960e77c11dc491da3961404cd485

See more details on using hashes here.

File details

Details for the file sxdm-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: sxdm-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 92.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.6.1 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.19.5 CPython/3.8.5

File hashes

Hashes for sxdm-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff060b5e91299066bf0d325bbb42f5a9c239fc0fbab7c96386610c719c212e51
MD5 728209e2d7ae6254d2dd2e2b34a9c173
BLAKE2b-256 401724d8721fb155ba32b7dbfff006a115e7948a755337d46e4b17e05c6140e8

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