Metadata-Version: 2.4
Name: mbs
Version: 0.2.2
Summary: Utilities for MB Scientific analyzer data
Author-email: Johannes Falke <Johannes.Falke@cpfs.mpg.de>
License: GPLv3
Project-URL: homepage, https://github.com/mueslo/mbs
Project-URL: documentation, https://mbsutils.readthedocs.io/
Keywords: arpes,spectroscopy,physics,science
Requires-Python: <4,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib~=3.4
Requires-Dist: pandas
Provides-Extra: docs
Requires-Dist: sphinx~=7.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: sphinx-gallery~=0.13; extra == "docs"
Requires-Dist: Pillow; extra == "docs"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Provides-Extra: xarray
Requires-Dist: xarray; extra == "xarray"
Provides-Extra: widgets
Requires-Dist: jupyterlab<5,>=3.2; extra == "widgets"
Requires-Dist: ipympl~=0.8; extra == "widgets"
Requires-Dist: ipywidgets<9,>=7.6; extra == "widgets"
Dynamic: license-file

[![](https://img.shields.io/github/release/mueslo/mbs.svg?style=flat-square)](https://github.com/mueslo/mbs/releases)
[![](https://img.shields.io/pypi/v/mbs.svg?style=flat-square)](https://pypi.org/project/mbs/)<!--
[![](https://img.shields.io/github/workflow/status/mueslo/mbs/tests.yml?branch=master&style=flat-square)](https://github.com/mueslo/mbs/actions/workflows/tests.yml)-->
[![](https://img.shields.io/readthedocs/mbsutils.svg?style=flat-square)](https://mbsutils.readthedocs.io)
[![](https://img.shields.io/github/license/mueslo/mbs.svg?style=flat-square)](https://github.com/mueslo/mbs/blob/master/LICENSE)


# MBS

Simple Python library for loading and plotting MB Scientific ARPES detector data in both KRX and TXT format.

## Installation

To install using `pip`, simply run `pip install mbs`.

To install using `conda`, please follow [these instructions](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-pkgs.html#installing-non-conda-packages), as `mbs` is not directly published on `conda` .

## Usage & Documentation

For some simple examples, see [mbs_example.ipynb](examples/mbs_example.ipynb). In case interactive widgets are not showing up, please follow [this guide](https://ipywidgets.readthedocs.io/en/stable/user_install.html).
Full documentation is still a work in progress will be found [here](https://mbsutils.readthedocs.org).

