Metadata-Version: 2.1
Name: ggce
Version: 0.1
Summary: Numerically exact Generalized Green's Function Cluster Expansion
Author-email: "Matthew R. Carbone" <mcarbone@bnl.gov>, Stepan Fomichev <fomichev@physics.ubc.ca>
Maintainer-email: "Matthew R. Carbone" <mcarbone@bnl.gov>, Stepan Fomichev <fomichev@physics.ubc.ca>
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: loguru
Requires-Dist: monty
Requires-Dist: tqdm
Requires-Dist: sphinx ; extra == "doc"
Requires-Dist: numpydoc ; extra == "doc"
Requires-Dist: sphinx-copybutton ; extra == "doc"
Requires-Dist: sphinx_rtd_theme ; extra == "doc"
Requires-Dist: ipython ; extra == "doc"
Requires-Dist: matplotlib ; extra == "doc"
Requires-Dist: codecov ; extra == "test"
Requires-Dist: coverage ; extra == "test"
Requires-Dist: flake8 ; extra == "test"
Requires-Dist: pytest ; extra == "test"
Requires-Dist: pytest-cov ; extra == "test"
Requires-Dist: black ; extra == "test"
Requires-Dist: nbstripout ; extra == "test"
Requires-Dist: pre-commit ; extra == "test"
Provides-Extra: doc
Provides-Extra: test


GGCE
====

.. image:: https://codecov.io/gh/x94carbone/GGCE/branch/master/graph/badge.svg?token=6Q7EUWBW6O
   :target: https://codecov.io/gh/x94carbone/GGCE
   :alt: codecov


Generalized Green's function Cluster Expansion

Installation
------------

We provide detailed information on how to install the GGCE package in our documentation (link TK).

Acknowledgements
----------------

.. inclusion-marker-acknowledgements-begin

This material is based upon work supported by the U.S. Department of Energy, Office of Science, Office of Advanced Scientific Computing Research, Department of Energy Computational Science Graduate Fellowship under Award Number DE-FG02-97ER25308. This work also used theory and computational resources of the Center for Functional Nanomaterials, which is a U.S. Department of Energy Office of Science User Facility, and the Scientific Data and Computing Center, a component of the Computational Science Initiative, at Brookhaven National Laboratory under Contract No. DE-SC0012704.

.. inclusion-marker-acknowledgements-end


Citation
--------

If you use this software, please cite our JOSS manuscript **(JOSS manuscript currently in prep)**.

If you make references to the theory or application of the GGCE methodology, please consider citing the following two manuscripts: `Carbone, Reichman et al. <https://journals.aps.org/prb/abstract/10.1103/PhysRevB.104.035106>`__ and `Carbone, Millis et al <https://journals.aps.org/prb/abstract/10.1103/PhysRevB.104.L140307>`__:

.. code-block::

   @article{carbone2021,
     title={Numerically exact generalized Green's function cluster expansions for electron-phonon problems},
     author={Carbone, Matthew R and Reichman, David R and Sous, John},
     journal={Phys. Rev. B.},
     volume={104},
     number={3},
     pages={035106},
     year={2021},
     publisher={APS}
   }

   @article{carbone2021bond,
     title={Bond-Peierls polaron: Moderate mass enhancement and current-carrying ground state},
     author={Carbone, Matthew R and Millis, Andrew J and Reichman, David R and Sous, John},
     journal={Phys. Rev. B.},
     volume={104},
     number={14},
     pages={L140307},
     year={2021},
     publisher={APS}
   }

