https://github.com/scikit-beam/scikit-beam

Data analysis tools for X-Ray, Neutron and Electron sciences
https://github.com/scikit-beam/scikit-beam

Last synced: 3 months ago
JSON representation

Data analysis tools for X-Ray, Neutron and Electron sciences

• Host: GitHub
• URL: https://github.com/scikit-beam/scikit-beam
• Owner: scikit-beam
• License: bsd-3-clause
• Created: 2014-07-10T04:44:35.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-07-26T15:36:07.000Z (over 1 year ago)
• Last Synced: 2024-08-02T18:37:51.089Z (3 months ago)
• Language: Python
• Homepage:
• Size: 8.01 MB
• Stars: 93
• Watchers: 22
• Forks: 61
• Open Issues: 84
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-physics - scikit-beam - Data analysis tools for X-Ray, Neutron and Electron sciences (Electromagnetism / Sound)

README

        
## [MAILING LIST](https://groups.google.com/forum/#!forum/scikit-beam)

# scikit-beam

[![Build Status](https://travis-ci.org/scikit-beam/scikit-beam.svg?branch=master)](https://travis-ci.org/scikit-beam/scikit-beam)

[![codecov.io](http://codecov.io/github/scikit-beam/scikit-beam/coverage.svg?branch=master)](http://codecov.io/github/scikit-beam/scikit-beam?branch=master)

[![Join the chat at https://gitter.im/scikit-beam/scikit-beam](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/scikit-xray/scikit-beam?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

**[Documentation](http://scikit-beam.github.io/scikit-beam/)**

## Examples

[scikit-beam-examples repository](https://github.com/scikit-beam/scikit-beam-examples)

- [Powder calibration (still needs tilt correction)](https://github.com/scikit-beam/scikit-beam-examples/blob/master/demos/powder_calibration/D_estimate_demo.ipynb)

- 1-time correlation

  - [dir](https://github.com/scikit-beam/scikit-beam-examples/tree/master/demos/1_time_correlation)

  - [Jupyter notebook](https://github.com/scikit-beam/scikit-beam-examples/blob/master/demos/1_time_correlation/Multi_tau_one_time_correlation_example.ipynb)

- Differential Phase Contrast

  - [dir](https://github.com/scikit-beam/scikit-beam-examples/blob/master/demos/dpc)

  - [Jupyter notebook](https://github.com/scikit-beam/scikit-beam-examples/blob/master/demos/dpc/dpc_demo.ipynb)

- [Fast conversion to reciprocal space](https://github.com/scikit-beam/scikit-beam-examples/blob/master/demos/reciprocal_space/recip_example.ipynb)

- [X-Ray Speckle Visibility Spectroscopy](https://github.com/scikit-beam/scikit-beam-examples/blob/master/demos/speckle/speckle-plotting.ipynb)

- [Basic Plotting of X-Ray Fluorescence Elemental Lines](https://github.com/scikit-beam/scikit-beam-examples/blob/master/demos/xrf/plot_xrf_spectrum.ipynb)

## Quick start

### install with conda

```

conda install scikit-beam -c nsls2forge

```

### install development version with setuptools

```

git clone [email protected]:scikit-beam/scikit-beam.git

cd scikit-beam

python setup.py install

```

### set up for development

```

git clone [email protected]:scikit-beam/scikit-beam.git

cd scikit-beam

python setup.py develop

pip install pytest coverage setuptools

```

**make sure all the tests pass!**

```

python run_tests.py

```

**and you can check the code coverage with**

```

coverage run run_tests.py

coverage report -m

```