diff --git a/README.md b/README.md index 21513bf..1c19135 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ # qutip-virtual-lab +![example workflow](https://github.com/qutip/qutip-virtual-lab/actions/workflows/deploy.yml/badge.svg) + A virtual laboratory interface to QuTiP for learning and exploring quantum mechanics on tablets, phones and in the browser. -## Quick Start +⚛ Go to QuTiP Virtual Lab ⚛ + +## Building for Development You will need to have installed: @@ -57,7 +61,7 @@ The UI is implemented in React and Typescript. For drawing the qubits, lasers, baths, and interactions, the application uses the `react-konva` library. The Bloch spheres in the Results tab are implemented use the `react-three-fiber` library. -## In Development +## Future Ideas Plots of results: - Hinton plots of results @@ -71,4 +75,10 @@ Performance: Styling: -- Responsiveness \ No newline at end of file +- Responsiveness + +----- + +Credits: + +- Made by [Trent Fridey](https://github.com/trentfridey) with help from [Alex Pitchford](https://github.com/ajgpitch) and [Simon Cross](https://github.com/hodgestar) \ No newline at end of file