qtpyt is the a python package for quantum transport simulations.
Project description
# pyqt
A quantum transport library based on the non equilibrium Green’s function (NEGF) formalism written in Python.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
> Ase https://wiki.fysik.dtu.dk/ase/ > numpy https://github.com/numpy
### Installing
pip install qtpy
Say what the step will be
` Give the example `
And repeat
` until finished `
End with an example of getting some data out of the system or using it for a little demo
## Running the tests
Explain how to run the automated tests for this system
### Break down into end to end tests
Explain what these tests test and why
` Give an example `
### And coding style tests
Explain what these tests test and why
` Give an example `
## Deployment
Add additional notes about how to deploy this on a live system
## Built With
[Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
[Maven](https://maven.apache.org/) - Dependency Management
[ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
Billie Thompson - Initial work - [PurpleBooth](https://github.com/PurpleBooth)
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
Hat tip to anyone whose code was used
Inspiration
etc
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.