Metadata-Version: 2.4
Name: py4mulas
Version: 0.1.0
Summary: py4mulas: a package for quantum transport response formulas and operators of periodic sytems in momentum space
Author-email: Ousmane Ly <ousmanebouneoumar@gmail.com>
License: BSD-3-Clause
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Requires-Dist: matplotlib>=3.7.5
Requires-Dist: numpy>=1.26.4
Requires-Dist: scipy>=1.13.0
Requires-Dist: sympy>=1.12.1
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: sphinx-rtd-theme>=3.1.0; extra == 'dev'
Provides-Extra: kwant
Requires-Dist: kwant>=1.4.2; extra == 'kwant'
Provides-Extra: parallel
Requires-Dist: mpi4py>=4.1.1; extra == 'parallel'
Description-Content-Type: text/markdown

Py4mulas is designed to start from a periodic Hamiltonian and compute tranport responses given spin, charge or orbital operators. It implements a generalized framework to define Kubo-like formulas in linear response and beyond. It also provides tools to visualize the system's band stracture with any operator expectation values along a path in momentum space, and compute momentum resolved quantities such as densities, currents and Berry curvatures. It can simulate different trasport phenomena in momentum space including linear and nonlinear Hall, Spin Hall, Orbital Hall and Octupole Hall effects.

## Contributing
There is always room to improvement. Contributions to the project are most welcome! 
If you encounter any bugs or have suggestions for improvements, please feel free to open an issue or submit a pull request.
For any related discussion please feel free to contact me at [ousmanebouneoumar@gmail.com](mailto:ousmanebouneoumar@gmail.com).

## Citing
To appropriately cite Py4mulas please see instructions at [CITING](https://py4mulas.readthedocs.io/en/latest/CITING.html)

## Documentation
Py4mulas documentation is hosted on [READ THE DOCS](https://py4mulas.readthedocs.io/en/latest/py4mulas.html)