Commit 96164935 authored by Tobias Hangleiter's avatar Tobias Hangleiter
Browse files

Update README.md, setup.py, __init__.py

parent 13b338ce
......@@ -18,10 +18,20 @@ This will link the files into your environment instead of copying them. If you a
## qutil.matlab
In this module there are functions that are helpful for reading `.mat` files, especially those created with special measure. If you simply want to open a random `.mat` file you can use `hdf5storage.loadmat`.
## qutil.const
This module defines all the constants you could wish for as well as functions to convert temperatures (`convert_temperature`) or between wavelengths and frequencies (`lambda2nu`, `nu2lambda`). For an overview, see the module docstring.
## qutil.linalg
This module provides several handy linear algebra functions. While some are implemented elsewhere, the implementation here is typically speedier for large arrays. For example, `pauli_expm` exploits the fact that a matrix exponential of Pauli matrices can be written as a cosine times the identity matrix plus a sine times the Paulis to speed up the calculation.
For an overview of the included functions, see the module docstring.
## qutil.ui
This module collects UI helpers, such as a progress bar for loops that can be used like so:
```python
for i in qutil.ui.progressbar(range(n)):
do_something()
```
## qutil.qi
In this module there are some quantities and functions related to quantum information, like the Pauli matrices in different data types.
from . import linalg, matlab, plotting, ui, qi
from . import const, linalg, matlab, plotting, ui, qi
__version__ = '0.1'
__all__ = ['linalg', 'matlab', 'ui', 'plotting', 'qi']
__all__ = ['const', 'linalg', 'matlab', 'ui', 'plotting', 'qi']
......@@ -33,7 +33,7 @@ setup(name='qutil',
packages=find_packages(),
package_dir={'qutil': 'qutil'},
python_requires='>=3.5',
install_requires=['numpy', 'hdf5storage', 'pandas'],
install_requires=['numpy', 'hdf5storage', 'pandas', 'scipy'],
extras_require={'fancy_progressbar': ['tqdm']},
classifiers=[
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment