Welcome to the QDYN documentation

Source code on FUB Gitlab GPL License

QDYN is a modern Fortran library for quantum dynamics and control. It contains data structures and routines for the efficient numerical modeling of a wide range of quantum systems, allowing to calculate static properties, simulate dynamics, and solve optimal control problems.

For basic usage, QDYN comes with a set of command line utilities. These read the description of a physical system from a config file and a collection of data files, and perform a simulation of the dynamics or an optimization. More advanced users would write their own Fortran programs using QDYN’s application programming interface (API).

How the documentation is organized

The Getting Started section is required reading for new users and contains instructions for the installation of QDYN, as well as tutorials that teach basic usage (todo). Following that, the main part of the documentation is organized in four categories:

  1. Examples: These are tutorials that showcase the use of QDYN for typical research problems. They serve as a learning resource for all users to become familiar with QDYN’s capabilities and usage, to be read selectively and in any order.

  2. How-Tos: Guides for achieving common tasks with QDYN, addressing any questions and problems in QDYN’s day-to-day usage. This should be understood as an “extended FAQ” for users and developers already familiar with QDYN’s basic concepts.

  3. Topical Overviews: In-depth explanations of numerical methods, implementation choices, and background information. These are intended for users interested in the “big picture” and QDYN developers. They are not required reading for normal usage of QDYN, although they will allow users to become more effective through deeper understanding of what methods are most appropriate in a given situation.

  4. Reference: Detailed descriptions of all of QDYN’s parts. This includes the full documentation of every module, data type and routine (the API), the documentation of every allowed parameter in the config file, and the documentation of all command line flags for the utilities included with QDYN. This information is a technical reference to be looked up as needed, but does not serve as a learning resource.

Lastly, the Notes for Developers contains detailed how-to guides targeted at developers working on the QDYN library itself. The information in this section is not relevant to normal users of QDYN.

Bibliography