Metadata-Version: 2.1
Name: pairinteraction
Version: 0.9.4a0
Summary: A Rydberg Interaction Calculator
Home-page: https://pairinteraction.github.io/
Author: Sebastian Weber, Henri Menke
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.11.0)
Requires-Dist: scipy (>=0.17.0)
Requires-Dist: pint
Requires-Dist: psutil

# Pairinteraction - A Rydberg Interaction Calculator

[![Travis Build Status][travis-svg]][travis-link]
[![AppVeyor Build Status][appveyor-svg]][appveyor-link]
[![Code Coverage Report][codecov-svg]][codecov-link]
[![PyPI Package][pypi-svg]][pypi-link]
[![arXiv:1612.08053][arXiv-svg]][arXiv-link]
[![License][license-svg]][gpl-link]

The *pairinteraction* software calculates properties of Rydberg systems. Visit the official website at https://pairinteraction.github.io/ for documentation and tutorials.
Binary builds are available through [GitHub Releases](https://github.com/pairinteraction/pairinteraction/releases).

For using pairinteraction as a Python 3 library, we recommend the installation via pip by calling `pip install pairinteraction`. If pairinteraction was installed from the command line, the graphical user interface can be started by executing `start_pairinteraction_gui`.

## Please cite us

> Sebastian Weber, Christoph Tresp, Henri Menke, Alban Urvoy, Ofer Firstenberg, Hans Peter BÃ¼chler, Sebastian Hofferberth, *Tutorial: Calculation of Rydberg interaction potentials*, [J. Phys. B: At. Mol. Opt. Phys. 50, 133001 (2017)][journal-link], [arXiv:1612.08053][arXiv-link]

## License

The pairinteraction library is licensed under the [LGPL v3][lgpl-link]. The extension for calculating
radial wave functions using Whittaker functions and the graphical user interface are licensed under the [GPL v3][gpl-link].
The GPL v3 also applies to the combined work and all provided binary builds.

[travis-svg]: https://img.shields.io/travis/pairinteraction/pairinteraction.svg?branch=master&style=flat&logo=travis
[travis-link]: https://travis-ci.org/pairinteraction/pairinteraction
[appveyor-svg]: https://ci.appveyor.com/api/projects/status/t5l4unwt210gq3al/branch/master?svg=true
[appveyor-link]: https://ci.appveyor.com/project/pairinteraction/pairinteraction/branch/master
[pypi-svg]: https://img.shields.io/pypi/v/pairinteraction.svg
[pypi-link]: https://pypi.org/project/pairinteraction/
[codecov-svg]: https://codecov.io/gh/pairinteraction/pairinteraction/branch/master/graph/badge.svg
[codecov-link]: https://codecov.io/gh/pairinteraction/pairinteraction
[arXiv-svg]: https://img.shields.io/badge/arXiv-1612.08053-b31b1b.svg?style=flat
[arXiv-link]: https://arxiv.org/abs/1612.08053
[license-svg]: https://img.shields.io/badge/License-GPLv3-blue.svg?style=flat
[gpl-link]: https://www.gnu.org/licenses/gpl-3.0.html
[lgpl-link]: https://www.gnu.org/licenses/lgpl-3.0.html
[journal-link]: https://doi.org/10.1088/1361-6455/aa743a


