Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

islatu-1.3.1.tar.gz (33.8 kB view details)

Uploaded Source

Built Distribution

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

islatu-1.3.1-py3-none-any.whl (37.4 kB view details)

Uploaded Python 3

File details

Details for the file islatu-1.3.1.tar.gz.

File metadata

  • Download URL: islatu-1.3.1.tar.gz
  • Upload date:
  • Size: 33.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for islatu-1.3.1.tar.gz
Algorithm Hash digest
SHA256 b25c00497e07f14abb6cbf337da75e680ff58b5757aea3719c3ca77134a84e85
MD5 dc933de3440af95e8642ff847c1721ff
BLAKE2b-256 b1e38d2fc35ece477aafbb30c784be7a35dbc5a16492d75e6a4a7916d32b12fc

See more details on using hashes here.

File details

Details for the file islatu-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: islatu-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 37.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for islatu-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 665c0d8ec67ed791c46f2fe0e1a2a74001e3473af7aa94e0edbc8d8d8c8de71f
MD5 bf0e1ca17c29c58a46e6bf4e573f08db
BLAKE2b-256 f1399d4acc45905b9afbdfd23eb94bf5d7cb899ce65ab1649675803117e9718c

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