From f7f6cf8c6aa83581cf3bf9df201568a626e45c58 Mon Sep 17 00:00:00 2001 From: Michael Hush Date: Thu, 25 Aug 2016 16:32:17 +1000 Subject: [PATCH] Initial release for 2.0.0 --- LICENSE => LICENSE.txt | 0 {docs => doc}/Makefile | 0 {docs => doc}/make.bat | 0 {docs => doc}/source/api/controllers.rst | 0 {docs => doc}/source/api/index.rst | 0 {docs => doc}/source/api/interfaces.rst | 0 {docs => doc}/source/api/launchers.rst | 0 {docs => doc}/source/api/learners.rst | 0 {docs => doc}/source/api/mloop.rst | 0 {docs => doc}/source/api/t_esting.rst | 0 {docs => doc}/source/api/utilities.rst | 0 {docs => doc}/source/api/visualizations.rst | 0 {docs => doc}/source/conf.py | 0 {docs => doc}/source/examples.rst | 0 {docs => doc}/source/images/M-LOOP_logo.ico | Bin {docs => doc}/source/images/M-LOOP_logo.pdf | Bin {docs => doc}/source/images/M-LOOP_logo.png | Bin {docs => doc}/source/images/M-LOOPandBEC.png | Bin {docs => doc}/source/index.rst | 0 {docs => doc}/source/install.rst | 4 ++-- {docs => doc}/source/options.rst | 0 {docs => doc}/source/tutorial.rst | 0 setup.cfg | 2 ++ setup.py | 5 +++-- 24 files changed, 7 insertions(+), 4 deletions(-) rename LICENSE => LICENSE.txt (100%) rename {docs => doc}/Makefile (100%) rename {docs => doc}/make.bat (100%) rename {docs => doc}/source/api/controllers.rst (100%) rename {docs => doc}/source/api/index.rst (100%) rename {docs => doc}/source/api/interfaces.rst (100%) rename {docs => doc}/source/api/launchers.rst (100%) rename {docs => doc}/source/api/learners.rst (100%) rename {docs => doc}/source/api/mloop.rst (100%) rename {docs => doc}/source/api/t_esting.rst (100%) rename {docs => doc}/source/api/utilities.rst (100%) rename {docs => doc}/source/api/visualizations.rst (100%) rename {docs => doc}/source/conf.py (100%) rename {docs => doc}/source/examples.rst (100%) rename {docs => doc}/source/images/M-LOOP_logo.ico (100%) rename {docs => doc}/source/images/M-LOOP_logo.pdf (100%) rename {docs => doc}/source/images/M-LOOP_logo.png (100%) rename {docs => doc}/source/images/M-LOOPandBEC.png (100%) rename {docs => doc}/source/index.rst (100%) rename {docs => doc}/source/install.rst (96%) rename {docs => doc}/source/options.rst (100%) rename {docs => doc}/source/tutorial.rst (100%) create mode 100644 setup.cfg diff --git a/LICENSE b/LICENSE.txt similarity index 100% rename from LICENSE rename to LICENSE.txt diff --git a/docs/Makefile b/doc/Makefile similarity index 100% rename from docs/Makefile rename to doc/Makefile diff --git a/docs/make.bat b/doc/make.bat similarity index 100% rename from docs/make.bat rename to doc/make.bat diff --git a/docs/source/api/controllers.rst b/doc/source/api/controllers.rst similarity index 100% rename from docs/source/api/controllers.rst rename to doc/source/api/controllers.rst diff --git a/docs/source/api/index.rst b/doc/source/api/index.rst similarity index 100% rename from docs/source/api/index.rst rename to doc/source/api/index.rst diff --git a/docs/source/api/interfaces.rst b/doc/source/api/interfaces.rst similarity index 100% rename from docs/source/api/interfaces.rst rename to doc/source/api/interfaces.rst diff --git a/docs/source/api/launchers.rst b/doc/source/api/launchers.rst similarity index 100% rename from docs/source/api/launchers.rst rename to doc/source/api/launchers.rst diff --git a/docs/source/api/learners.rst b/doc/source/api/learners.rst similarity index 100% rename from docs/source/api/learners.rst rename to doc/source/api/learners.rst diff --git a/docs/source/api/mloop.rst b/doc/source/api/mloop.rst similarity index 100% rename from docs/source/api/mloop.rst rename to doc/source/api/mloop.rst diff --git a/docs/source/api/t_esting.rst b/doc/source/api/t_esting.rst similarity index 100% rename from docs/source/api/t_esting.rst rename to doc/source/api/t_esting.rst diff --git a/docs/source/api/utilities.rst b/doc/source/api/utilities.rst similarity index 100% rename from docs/source/api/utilities.rst rename to doc/source/api/utilities.rst diff --git a/docs/source/api/visualizations.rst b/doc/source/api/visualizations.rst similarity index 100% rename from docs/source/api/visualizations.rst rename to doc/source/api/visualizations.rst diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 100% rename from docs/source/conf.py rename to doc/source/conf.py diff --git a/docs/source/examples.rst b/doc/source/examples.rst similarity index 100% rename from docs/source/examples.rst rename to doc/source/examples.rst diff --git a/docs/source/images/M-LOOP_logo.ico b/doc/source/images/M-LOOP_logo.ico similarity index 100% rename from docs/source/images/M-LOOP_logo.ico rename to doc/source/images/M-LOOP_logo.ico diff --git a/docs/source/images/M-LOOP_logo.pdf b/doc/source/images/M-LOOP_logo.pdf similarity index 100% rename from docs/source/images/M-LOOP_logo.pdf rename to doc/source/images/M-LOOP_logo.pdf diff --git a/docs/source/images/M-LOOP_logo.png b/doc/source/images/M-LOOP_logo.png similarity index 100% rename from docs/source/images/M-LOOP_logo.png rename to doc/source/images/M-LOOP_logo.png diff --git a/docs/source/images/M-LOOPandBEC.png b/doc/source/images/M-LOOPandBEC.png similarity index 100% rename from docs/source/images/M-LOOPandBEC.png rename to doc/source/images/M-LOOPandBEC.png diff --git a/docs/source/index.rst b/doc/source/index.rst similarity index 100% rename from docs/source/index.rst rename to doc/source/index.rst diff --git a/docs/source/install.rst b/doc/source/install.rst similarity index 96% rename from docs/source/install.rst rename to doc/source/install.rst index 06c723d..a9cc22d 100644 --- a/docs/source/install.rst +++ b/doc/source/install.rst @@ -70,9 +70,9 @@ In the M-LOOP source code directory. The tests should take around three minutes Documentation ------------- -If you would also like a local copy of the documentation enter the docs folder and use the command:: +If you would also like a local copy of the documentation enter the doc folder and use the command:: make html -Which will generate the documentation in docs/build/html. +Which will generate the documentation in doc/build/html. diff --git a/docs/source/options.rst b/doc/source/options.rst similarity index 100% rename from docs/source/options.rst rename to doc/source/options.rst diff --git a/docs/source/tutorial.rst b/doc/source/tutorial.rst similarity index 100% rename from docs/source/tutorial.rst rename to doc/source/tutorial.rst diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..5aef279 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +description-file = README.rst diff --git a/setup.py b/setup.py index 1c23bc0..7b16cbc 100644 --- a/setup.py +++ b/setup.py @@ -23,9 +23,10 @@ description = 'M-LOOP: Machine-learning online optimization package. A python package of automated optimization tools - enhanced with machine-learning - for quantum scientific experiments, computer controlled systems or other optimization tasks.', license = 'MIT', keywords = 'automated machine learning optimization optimisation science experiment quantum', - url = 'https://github.com/michaelhush/M-LOOP/', + url = 'https://github.com/michaelhush/M-LOOP/', + download_url = 'https://github.com/michaelhush/M-LOOP/tarball/v2.0.0', - classifiers = ['Development Status :: 3 - Alpha', + classifiers = ['Development Status :: 2 - Pre-Alpha', 'Intended Audience :: Science/Research', 'Intended Audience :: Manufacturing', 'License :: OSI Approved :: MIT License',