A package for the reduction of reflectometry data.
Project description
# islatu
X-ray reflectometry reduction from Diamond Light Source
[![codecov](https://codecov.io/gh/RBrearton/islatu/branch/master/graph/badge.svg?token=FGIV0MVHS8)](https://codecov.io/gh/RBrearton/islatu) [![Actions Status](https://github.com/RBrearton/islatu/workflows/pytest/badge.svg)](https://github.com/pytest/islatu/actions) [![Documentation Status](https://readthedocs.org/projects/islatu/badge/?version=latest)](https://islatu.readthedocs.io/en/latest/?badge=latest)
### Install
This package can be easily installed using pip install islatu.
### Installation from source
To install in a fresh environment, first ensure that pip is available. For example, using conda:
` conda create --name islatu conda activate islatu conda install pip `
Assuming that pip is available, installation of the library from source can be done by cloning this repository. Navigate to its directory and use pip to install this package and its dependencies as follows:
` python -m pip install . -r requirements.txt `
Make sure that your installation is functioning by running pytest.
### Documentation
The documentation for this package can be found at https://islatu.readthedocs.io/en/latest/
An example of a typical data reduction workflow can be found at https://islatu.readthedocs.io/en/latest/i07_reflectivity.html
To build the documentation, make sure you have sphinx installed on your system. Go to the docs directory and run
` make html `
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file islatu-1.0.7.tar.gz
.
File metadata
- Download URL: islatu-1.0.7.tar.gz
- Upload date:
- Size: 26.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bea736ef21c48f47c43fc8505d938207fab4d3655886d4375672693600ee033 |
|
MD5 | 03b65b87c62823e4b310e8c8c893b3e5 |
|
BLAKE2b-256 | 35500d17fc7d6544f4801b06147602904c96df7c92bef3efe0ac33bfe84089a9 |
File details
Details for the file islatu-1.0.7-py3-none-any.whl
.
File metadata
- Download URL: islatu-1.0.7-py3-none-any.whl
- Upload date:
- Size: 30.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e25224e37df3b37b92fdd9b18b9f56c7d44ec1cd6aeeb7c5c3f753af68150126 |
|
MD5 | 6598fdd29b62b78e71ee4927375f88e8 |
|
BLAKE2b-256 | 5785e823ce0fa8fd552df5b247cf45d7b6b443f378fcb7c9fc265fa6ccf2964a |