Metadata-Version: 2.1
Name: qdyn
Version: 21.7.dev9
Summary: Python package for interacting with the Fortran QDYN library and tools
Home-page: https://www.qdyn-library.net
Author: Michael Goerz
Author-email: mail@michaelgoerz.net
License: BSD license
Keywords: qdyn
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: scipy
Requires-Dist: sympy
Requires-Dist: click
Provides-Extra: dev
Requires-Dist: better-apidoc ; extra == 'dev'
Requires-Dist: coverage ; extra == 'dev'
Requires-Dist: coveralls ; extra == 'dev'
Requires-Dist: doctr-versions-menu ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: gitpython ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: ipython ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: pdbpp ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-xdist ; extra == 'dev'
Requires-Dist: qutip ; extra == 'dev'
Requires-Dist: m2r ; extra == 'dev'
Requires-Dist: recommonmark ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-autobuild ; extra == 'dev'
Requires-Dist: sphinx-copybutton ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'

# QDYN Python Package

QDYN-pylib is a Python package `qdyn` for interacting with the [Fortran QDYN library and tools](https://www.qdyn-library.net/). Its purpose is to:

- generate config files and input data for QDYN
- read data generated by QDYN routines
- provide tools for debugging, testing, and documenting QDYN
- wrap QDYN's "utility" programs like `qdyn_prop_traj` and `qdyn_optimize`
- provide interoperability of QDYN with other optimal control and quantum packages like [`scipy.optimize`](https://docs.scipy.org/doc/scipy/reference/optimize.html), [QuTiP](http://qutip.org) and the [Krotov Python Package](https://qucontrol.github.io/krotov).

The package is *not* a direct wrapper around QDYN that would allow to call QDYN Fortran routines from Python.

## Installation

To install the latest released version of QDYN-pylib, run this command in your terminal:

```
pip install qdyn
```

This is the preferred method to install QDYN-pylib, as it will always install the most recent stable release.

If you are a QDYN developer, you can install the latest development version of QDYN-pylib with the following command:

```
pip install git+git@gitlabph.physik.fu-berlin.de:ag-koch/qdyn.git@master#egg=qdyn&subdirectory=qdynpylib
```


