Skip to main content

Tools for analyzing Scanning X-ray Diffraction Microscopy data

Project description

SXDM is a library for analyzing Scanning X-Ray Diffraction Micriscopy data for materials science, chemistry and similar fields. The major focus is on Scanning Micriscopy frames collected at multiple incident angles. One can import, retrieve, and analyze 26 - ID - C datasets 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)

Installation (pip)

  • pip install sxdm

Installation (git)

  • Make a clone of the SXDM project onto your machine

  • Possibly create a virtual environment

  • Run/install requirements.txt file

Virtual Environment & Jupyter Setup (git)

  • cd to directory you would like to keep the virtual environment

  • run python3 -m venv projectname in the terminal. projectname can be anything the User would like it to be

  • run source projectname/bin/activate

  • run pip3 install ipykernel

  • run ipython kernel install –user –name=projectname

  • run pip3 install -r requirements.txt for the sxdm repository

  • in jupyter notebook/lab run import sys and sys.path.append(“/path/to/module/”)

  • if you are running on a Mac then:

  • run in jupyter notebook/lab import sys

  • run in jupyter notebook/lab sys.path.append(‘/Users/usr/virtual_environment/lib/python3.7/site-packages/’)

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-0.5.4.tar.gz (4.2 MB view hashes)

Uploaded Source

Built Distribution

sxdm-0.5.4-py3-none-any.whl (84.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page