******
Readme
******

License
=======

The ``ODToolkit`` is distributed under `MIT License <https://choosealicense.com/licenses/mit/>`_. Include this
copyright notice in your work.

Authors
=======

The ``ODToolkit`` was initially developed by **Tianyu Zhang** <tzhang6@ualberta.ca> and
**Abdullah Al Zishan** <azishan@ualberta.ca> in 2019. The project is supported by the **Sustainable Computing Lab** at
the `University of Alberta <https://uab.ca>`_.

``Reference goes here after published``

How to get involved?
====================

We welcome various types of contributions such as bug reports, pull requests, etc., and encourage the community to
improve and augment this toolkit by adding their occupancy estimation models and/or their data sets.
Feel free to reach us through `Github <https://github.com/sustainable-computing/ODToolkit>`_ with regard to any
concerns you might have.

If you find this toolkit helpful, we appreciate if you cite our publication.

``Reference style here``

Contact
=======
You can send email to **Tianyu Zhang** <tzhang6@ualberta.ca> or **Dr. Omid Ardakanian** <oardakan@ualberta.ca> for
questions and concerns about this toolkit.