Metadata-Version: 2.1
Name: qudra
Version: 0.1.0
Summary: Quantum Energy Management
Home-page: https://github.com/Q-Energy-2022/NYUAD-2022
Author: Asil Qraini, Fouad Afiouni, Gargi Chandrakar, Nurgazy Seidaliev, Sahar Ben Rached, Salem Al Haddad, Sarthak Prasad Malla. Mentors: Akash Kant, Shantanu Jha.
Author-email: shantanu.rajesh.jha@gmail.com
License: MIT
Project-URL: Documentation, https://github.com/Q-Energy-2022/NYUAD-2022
Project-URL: Source Code, https://github.com/Q-Energy-2022/NYUAD-2022
Project-URL: Tutorials, https://github.com/Q-Energy-2022/NYUAD-2022/tree/main/tutorials
Description: # qudra
        *Quantum Energy Management*
        
        [![License](https://img.shields.io/github/license/Q-Energy-2022/qudra.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)
        [![](https://img.shields.io/github/release/Q-Energy-2022/qudra.svg?style=popout-square)](https://github.com/Q-Energy-2022/qudra/releases)
        [![](https://img.shields.io/pypi/dm/qudra.svg?style=popout-square)](https://pypi.org/project/qudra/)
        
        
        ## Motivation
        
        Leveraging quantum advantage to distributed grids for energy security and sustainability.
        
        *Please check out these slides for more [information](https://www.canva.com/design/DAE8pdmu5A0/F-bEPUubsNa9QMclkktCsg/view).*
        ## Installation
        
        Our team's contribution is supposed to go into the `qudra` folder. So move there
        ```console
        cd qudra
        ```
        
        *Conda users, please make sure to `conda install pip` before running any pip installation if you want to install `qudra` into your conda environment.*
        
        `qudra` is published on PyPI. So, to install, simply run:
        
        ```bash
        pip install qudra
        ```
        If you also want to download the dependencies needed to run optional tutorials, please use `pip install qudra[dev]` or `pip install 'qudra[dev]'` (for `zsh` users).
        
        
        To check if the installation was successful, run:
        
        ```python
        >>> import qudra
        ```
        
        ## Building from source
        
        To build `qudra` from source, pip install using:
        
        ```bash
        git clone https://github.com/Q-Energy-2022/qudra.git
        cd qudra
        pip install --upgrade .
        ```
        
        If you also want to download the dependencies needed to run optional tutorials, please use `pip install --upgrade .[dev]` or `pip install --upgrade '.[dev]'` (for `zsh` users).
        
        
        #### Installation for Devs
        
        If you intend to contribute to this project, please install `qudra` in editable mode as follows:
        ```bash
        git clone https://github.com/Q-Energy-2022/qudra.git
        cd qudra
        pip install -e .[dev]
        ```
        
        python3 -m venv venv
        . venv/bin/activate
        Please use `pip install -e '.[dev]'` if you are a `zsh` user.
        
        #### Building documentation locally
        
        Set yourself up to use the `[dev]` dependencies. Then, from the command line run:
        ```bash
        mkdocs build
        ```
        
        Then, when you're ready to deploy, run:
        ```bash
        mkdocs gh-deploy
        ```
        
        ## Acknowledgements
        
        **Core Devs:** [Asil Qraini](https://github.com/AsilQ), [Fouad Afiouni](https://github.com/fo-ui), [Gargi Chandrakar](https://github.com/gargi2718), [Nurgazy Seidaliev](https://github.com/nursei7), [Sahar Ben Rached](https://github.com/saharbenrached), [Salem Al Haddad](https://github.com/salemalhaddad), [Sarthak Prasad Malla](https://github.com/SarthakMalla1154)
        
        **Mentors:** [Akash Kant](https://github.com/akashkthkr), [Shantanu Jha](https://github.com/Phionx)
        
        This project was created at the [2022 NYUAD Hackathon](https://nyuad.nyu.edu/en/events/2022/march/nyuad-hackathon-event.html) for Social Good in the Arab World: Focusing on Quantum Computing (QC). 
        
        
Keywords: qubo energy vqe quantum computing
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
