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.1.0.tar.gz (28.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.1.0-py3-none-any.whl (32.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for islatu-1.1.0.tar.gz
Algorithm Hash digest
SHA256 7d9ed70997dc464de5e926475d1e8443d7d466ef935860e7f9caa3b860577611
MD5 91480438dcd30e2c62c213ece1c744de
BLAKE2b-256 dd70c12b37d887bb8dc555dc542ec23bc75378bcb3984e75ac62e4069cb7b260

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for islatu-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 05186126534c1777dbd3b53525ebd0ecb78a6a86da0c658365f3155544a7146c
MD5 8dbd43d1dc3279ffcd10ee4081905e68
BLAKE2b-256 5cafa6d8242d1876b65da0c123794d82df70b4184364b831c4ae9d21efc47726

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