Merge pull request #122 from Quantum-TII/logo

QIBO logo

Author: scarrazza

.github/workflows/rules.yml

@@ -18,9 +18,8 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install package
       run: |
-        pip install tensorflow
-        pip install cirq
-        pip install .[docs]
+        pip install -r requirements.txt
+        pip install .[docs,tests]
     - name: Test with pytest
       run: |
         pip install pytest-cov

README.md

@@ -1,8 +1,8 @@
+![logo](doc/source/qibo_logo.svg)
+
 ![Tests](https://github.com/Quantum-TII/qibo/workflows/Tests/badge.svg)
 [![codecov](https://codecov.io/gh/Quantum-TII/qibo/branch/master/graph/badge.svg?token=1EKZKVEVX0)](https://codecov.io/gh/Quantum-TII/qibo)
 
-# QIBO
-
 QIBO is an open-source high-level API, written in Python and capable of performing classical simulation of quantum algorithms.
 
 Some of the key features of QIBO are:

doc/source/conf.py

@@ -97,3 +97,9 @@
 def setup(app):
     app.add_config_value("recommonmark_config", {"enable_eval_rst": True}, True)
     app.add_transform(AutoStructify)
+
+html_logo = "logo.png"
+
+html_theme_options = {
+    'logo_only': True,
+}

doc/source/logo.png

@@ -0,0 +1,6 @@
+# Runtime requirements for qibo
+
+numpy
+tensorflow>=2.1
+scipy
+cma

doc/source/logo_black.png

@@ -9,7 +9,7 @@
 
 PACKAGE = "qibo"
 
-
+# Returns the qibo version
 def get_version():
     """ Gets the version from the package's __init__ file
     if there is some problem, let it happily fail """
@@ -21,7 +21,7 @@ def get_version():
         if mo:
             return mo.group(1)
 
-
+# Custom compilation step
 class Build(_build_py):
     def run(self):
         commands = [
@@ -33,6 +33,7 @@ def run(self):
         _build_py.run(self)
 
 
+# Register wheel with binary version
 class BinaryDistribution(Distribution):
   """This class is needed in order to create OS specific wheels."""
 
@@ -43,11 +44,16 @@ def is_pure(self):
     return False
 
 
+# Read in requirements
+requirements = open('requirements.txt').readlines()
+requirements = [r.strip() for r in requirements]
+
+
 setup(
     name="qibo",
     version=get_version(),
     description="Quantum computing framework",
-    author="TII-Qilimanjaro team",
+    author="Quantum-TII team",
     author_email="",
     url="https://github.com/Quantum-TII/qibo",
     packages=find_packages("src"),
@@ -58,17 +64,15 @@ def is_pure(self):
     zip_safe=False,
     distclass=BinaryDistribution,
     classifiers=[
-        "Operating System :: Unix",
-        "Programming Language :: Python",
         "Programming Language :: Python :: 3",
-        "Topic :: Scientific/Engineering",
         "Topic :: Scientific/Engineering :: Physics",
     ],
-    setup_requires=["tensorflow>=2.1"],
-    install_requires=["numpy", "tensorflow>=2.1", "scipy", "cma"],
+    setup_requires=requirements,
+    install_requires=requirements,
     extras_require={
-        "docs": ["sphinx", "sphinx_rtd_theme", "recommonmark", "sphinxcontrib-bibtex"]
+        "docs": ["sphinx", "sphinx_rtd_theme", "recommonmark", "sphinxcontrib-bibtex"],
+        "tests": ["cirq"],
     },
-    python_requires=">=3.6",
+    python_requires=">=3.6.0",
     long_description="See readthedocs webpage with the documentation",
 )