|Codacy Badge| |codecov| |CI| |DOI|

VOTCA-XTP is a library which allows you to calculate the electronic
properties of organic materials, e.g. - excited state properties via
GW-BSE - spectra using QM/MM in conjunction with excited state treatment
via GW-BSE - energetic disorder for electrons/holes and excitons via
QM/MM or fast MM/MM multipole methods - electron and hole mobilities
using electronic couplings and kinetic Monte-Carlo - electron, hole,
singlet and triplet diffusion constants using electronic couplings and
kinetic Monte-Carlo.

Documentation can be found on our `website <https://www.votca.org/>`__

Installation instructions and developer information can be found
`here <https://github.com/votca/votca/blob/master/share/sphinx/INSTALL.rst>`__

For other questions, we provide an email list:

`google group <https://groups.google.com/forum/#!forum/votca>`__

and a slack channel:

`Slack <https://votca.slack.com/messages/C7XVBE9EG/?>`__

We have no manual at the moment but we have a complete tutorial here:

`Tutorial <https://github.com/votca/xtp-tutorials>`__

The development of VOTCA is mainly funded by academic research grants.
If you use this package, please cite the VOTCA papers:

-  Excited-State Electronic Structure of Molecules Using Many-Body
   Green’s Functions: Quasiparticles and Electron-Hole Excitations with
   VOTCA-XTP. Gianluca Tirimbò, Vivek Sundaram, Onur Çaylak, Wouter
   Scharpach, Javier Sijen, Christoph Junghans, Joshua Brown, Felipe
   Zapata Ruiz, Nicolas Renaud, Jens Wehner, Björn Baumeier, J. Chem.
   Phys. 152, 114103 (2020).

-  Electronic Excitations in Complex Molecular Environments: Many-Body
   Green’s Functions Theory in VOTCA-XTP. Jens Wehner, Lothar
   Brombacher, Joshua Brown, Christoph Junghans, Onur Caylak, Yuriy
   Khalak, Pranav Madhikar, Gianluca Tirimbo, Björn Baumeier, J. Chem.
   Theory Comput. 14, 6353 (2018).

-  Microscopic simulations of charge transport in disordered organic
   semiconductors. V. Ruehle, A. Lukyanov, F. May, M. Schrader, T.
   Vehoff, J. Kirkpatrick, B. Baumeier and D. Andrienko, J. Chem. Theo.
   Comp. 7, 3335-3345 (2011). 

-  Versatile Object-oriented Toolkit for Coarse-graining Applications.
   V.Ruehle, C. Junghans, A. Lukyanov, K. Kremer, D. Andrienko, J. Chem.
   Theo. Comp. 5 (12), 3211 (2009).

In case of questions, please post them in the google discussion group
for votca at http://groups.google.com/g/votca
You can contact the VOTCA Development Team at devs@votca.org.

.. |Codacy Badge| image:: https://app.codacy.com/project/badge/Grade/b9c7170d5c3440b7a2327a667cb1ec59
   :target: https://www.codacy.com/gh/votca/xtp?utm_source=github.com&utm_medium=referral&utm_content=votca/xtp&utm_campaign=Badge_Grade
.. |codecov| image:: https://codecov.io/gh/votca/xtp/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/votca/xtp
.. |CI| image:: https://github.com/votca/votca/workflows/CI/badge.svg?branch=master
   :target: https://github.com/votca/votca/actions?query=workflow%3ACI+branch%3Amaster
.. |DOI| image:: https://zenodo.org/badge/50048374.svg
   :target: https://zenodo.org/badge/latestdoi/50048374

License:

Copyright 2009-2021 The VOTCA Development Team (http://www.votca.org)


Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at

::

       http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
