Skip to content

YellowSub17/scorpy-pkg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SCORPY

Scattering CORrelation in PYthon

Read the paper!

Citation: Adams, P., Greaves, T. L. & Martin, A. V. (2024). Crystal structure via fluctuation scattering. IUCrJ, 11. https://journals.iucr.org/m/issues/2024/04/00/it5033/index.html

package requirements

python 3.13.11
numpy 2.3.5
matplotlib 3.10.8
h5py 3.15.1
skimage 0.25.2
regex 2025.11.3
numba 0.63.1
pyshtools 4.13.1
pycifrw 5.0.1

Conda Setup (Requirements)

Use the following commands to set up a conda environment.

conda deactivate
conda create -n scorpy python=3.13 --yes
conda activate scorpy --yes
conda install numpy --yes
conda install matplotlib --yes
conda install h5py --yes
conda install scikit-image --yes
conda install regex --yes
conda install numba --yes
conda install conda-forge::pyshtools --yes
conda install conda-forge::pycifrw --yes

Installation

To install scorpy, run the following commands to download the package, move into the directory and install an editable verision of the package. This will create a link from your python site-package directory to an egg-info directory.

git clone https://github.com/YellowSub17/scorpy-pkg.git
cd scorpy-pkg
pip install -e .

Example scripts

See this other repo for a collection of scripts demonstrating scorpy

https://github.com/YellowSub17/scorpy-tute

About

Scattering Correlation in Python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages