scnc
/
qiskit
mirror of https://github.com/Qiskit/qiskit.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qiskit/Makefile

63 lines
2.0 KiB
Makefile
Raw Normal View History

Consistent license across all the project (#550) * Consistent license across all the project * Update license * Update LICENSE.txt * Update licenses * Fix linter
2018-06-08 21:00:58 +08:00
# Copyright 2017, IBM.
Minor licensing changes.
2017-05-12 00:12:57 +08:00
#
Consistent license across all the project (#550) * Consistent license across all the project * Update license * Update LICENSE.txt * Update licenses * Fix linter
2018-06-08 21:00:58 +08:00
# This source code is licensed under the Apache License, Version 2.0 found in
# the LICENSE.txt file in the root directory of this source tree.
Add "make test_ci" target for CIs, simplify "make test" (#1745) * Add test_ci make target, revert make test Add a new "test_ci" target to the Makefile, aimed at being used by the CIs. Update the "test" family of targets in order to revert back to the behaviour that involves less overhead and complexity for the users. * Update travis in order to use test_ci * Add documentation about test_ci target
2019-02-06 05:28:16 +08:00
.PHONY: env lint test doc test_record test_mock test_ci
Makedile and Travis support added.
2017-05-08 21:25:14 +08:00
Support to install as a library with pip (instead Anaconda). Only if the user doesn't need the GUI (Jupyter).
2017-06-20 23:17:11 +08:00
# Dependencies need to be installed on the Anaconda virtual environment.
Makedile and Travis support added.
2017-05-08 21:25:14 +08:00
env:
Issue #1691: Fixed a minor conda env bug in Makefile (#1693) * Issue #000: ignore case when testing conda env exists * Fixed a minor conda env bug in Makefile (#1691).
2019-01-21 20:03:51 +08:00
if test $(findstring qiskitenv, $(shell conda info --envs | tr '[:upper:]' '[:lower:]')); then \
bash -c "source activate Qiskitenv;pip install -r requirements.txt"; \
fixes issue #17 This addresses an issue with installation of setuptools during initial 'make env'. 'make env' also tries to deal more gracefully with previous run of the target.
2017-08-08 04:44:17 +08:00
else \
Issue #1691: Fixed a minor conda env bug in Makefile (#1693) * Issue #000: ignore case when testing conda env exists * Fixed a minor conda env bug in Makefile (#1691).
2019-01-21 20:03:51 +08:00
conda create -y -n Qiskitenv python=3; \
bash -c "source activate Qiskitenv;pip install -r requirements.txt"; \
fixes issue #17 This addresses an issue with installation of setuptools during initial 'make env'. 'make env' also tries to deal more gracefully with previous run of the target.
2017-08-08 04:44:17 +08:00
fi;
Support to install as a library with pip (instead Anaconda). Only if the user doesn't need the GUI (Jupyter).
2017-06-20 23:17:11 +08:00
Ignoring generated files in the linter.
2017-05-11 18:59:08 +08:00
# Ignoring generated ones with .py extension.
Makedile and Travis support added.
2017-05-08 21:25:14 +08:00
lint:
Add linter/style check to travis * Relax the pylint output disabling several warnings. * Reintroduce the linting of qiskit.extensions and qiskit.qasm.node. * Add a `style` target to the Makefile that performs pycodestyle, and reduce the verbosity of `lint` by removing the report. * Update the Travis configuration in order to add a new step that performs linter and style checks via an environment variable.
2017-12-29 07:41:24 +08:00
pylint -rn qiskit test
style:
Convert qiskit.tools to modules, lint (#275) Convert `qiskit.tools` to real Python modules by adding __init__.py, adding lint and style fixes in the process. Enable style and lint Travis check for qiskit.tools.
2018-02-05 18:47:53 +08:00
pycodestyle --max-line-length=100 qiskit test
Makedile and Travis support added.
2017-05-08 21:25:14 +08:00
Fix the tests for the C++ simulator changes Fix the failing tests for the C++ simulator via: * relaxing test_local_qiskit_simulator, just comparing that the keys of get_counts match the expected ones instead of comparing the values as well, due to an issue with randomness. * start the unittest discovery on the "test/" directory, instead of the root directory, as otherwise the QuantumCircuit header will be modified by the time the C++ gate files are read (and the tests that compare the lenghts of the QASMs will fail due to the extra definitions).
2018-01-05 03:21:21 +08:00
# Use the -s (starting directory) flag for "unittest discover" is necessary,
# otherwise the QuantumCircuit header will be modified during the discovery.
Reorder Folders
2017-05-09 04:17:43 +08:00
test:
Add "make test_ci" target for CIs, simplify "make test" (#1745) * Add test_ci make target, revert make test Add a new "test_ci" target to the Makefile, aimed at being used by the CIs. Update the "test" family of targets in order to revert back to the behaviour that involves less overhead and complexity for the users. * Update travis in order to use test_ci * Add documentation about test_ci target
2019-02-06 05:28:16 +08:00
python3 -m unittest discover -s test -v
Erick/discovery profiling (#68) * get list of circuit names in program * Enable len(circuit), circuit[n], and len(register). This allows circuits and registers to behave more like lists. len(circuit): number of instructions in circuit circuit[n]: nth instruction added to circuit len(register): size of register * Add profiling facility. Test for QasmSimulator. Makefile modified to allow profiling with python's unittest discovery facility. Test files are in same directory as the module they test. Make targets changed so that make test: looks for tests matching "test*.py" and "*_test.py". make profile: looks for unittest profiling matching "*_profile.py" To avoid file pollution discovery matching "*_profile.py" pattern gets routed to test module by generating a profiling suite of tests. This is done with unittest's "load_tests" facility. * Fix test to work with jsonbackend. Also, fixed warnings during test about unclosed file in lexer.
2017-07-05 21:05:19 +08:00
Save network interactions to allow tests to run offline by providing mocked responses (#697) The current commit introduces several changes to the testing infrastructure. First, it provides a way of running IBM-Q tests against pre-recorded responses. The software in charge of recording and mocking-up the responses is VCRPy[1] and it is configured and used in `test/common.py`. Cassettes can be updated by using `make test_recording`. [1] https://github.com/kevin1024/vcrpy The commit also includes the latest responses (under `tests/casettes`) for a successful test run but a default execution with `make test` will only use them if no IBM-Q credentials are found. To force a run against mocked responses, use `make test_mock`. Finally, the commit also unifies the several test options in a unique environmental variable called `QISKIT_TESTS` (in `tests/python/_test_options.py`). These are the main equivalences but the set of options is described in the developer introduction [2]: - `SKIP_SLOW_TESTS=False` is now achieved by `QISKIT_TESTS=run_slow` - `SKIP_ONLINE_TESTS=1` is now achieved by `QISKIT_TESTS=skip_online` [2] https://github.com/Qiskit/qiskit-terra/blob/master/doc/dev_introduction.rst#testing-options
2018-08-21 02:42:23 +08:00
test_mock:
Add "make test_ci" target for CIs, simplify "make test" (#1745) * Add test_ci make target, revert make test Add a new "test_ci" target to the Makefile, aimed at being used by the CIs. Update the "test" family of targets in order to revert back to the behaviour that involves less overhead and complexity for the users. * Update travis in order to use test_ci * Add documentation about test_ci target
2019-02-06 05:28:16 +08:00
env QISKIT_TESTS=mock_online python3 -m unittest discover -s test -v
Save network interactions to allow tests to run offline by providing mocked responses (#697) The current commit introduces several changes to the testing infrastructure. First, it provides a way of running IBM-Q tests against pre-recorded responses. The software in charge of recording and mocking-up the responses is VCRPy[1] and it is configured and used in `test/common.py`. Cassettes can be updated by using `make test_recording`. [1] https://github.com/kevin1024/vcrpy The commit also includes the latest responses (under `tests/casettes`) for a successful test run but a default execution with `make test` will only use them if no IBM-Q credentials are found. To force a run against mocked responses, use `make test_mock`. Finally, the commit also unifies the several test options in a unique environmental variable called `QISKIT_TESTS` (in `tests/python/_test_options.py`). These are the main equivalences but the set of options is described in the developer introduction [2]: - `SKIP_SLOW_TESTS=False` is now achieved by `QISKIT_TESTS=run_slow` - `SKIP_ONLINE_TESTS=1` is now achieved by `QISKIT_TESTS=skip_online` [2] https://github.com/Qiskit/qiskit-terra/blob/master/doc/dev_introduction.rst#testing-options
2018-08-21 02:42:23 +08:00
test_recording:
-rm test/cassettes/*
Add "make test_ci" target for CIs, simplify "make test" (#1745) * Add test_ci make target, revert make test Add a new "test_ci" target to the Makefile, aimed at being used by the CIs. Update the "test" family of targets in order to revert back to the behaviour that involves less overhead and complexity for the users. * Update travis in order to use test_ci * Add documentation about test_ci target
2019-02-06 05:28:16 +08:00
env QISKIT_TESTS=rec python3 -m unittest discover -s test -v
test_ci:
stestr run --concurrency 2
Save network interactions to allow tests to run offline by providing mocked responses (#697) The current commit introduces several changes to the testing infrastructure. First, it provides a way of running IBM-Q tests against pre-recorded responses. The software in charge of recording and mocking-up the responses is VCRPy[1] and it is configured and used in `test/common.py`. Cassettes can be updated by using `make test_recording`. [1] https://github.com/kevin1024/vcrpy The commit also includes the latest responses (under `tests/casettes`) for a successful test run but a default execution with `make test` will only use them if no IBM-Q credentials are found. To force a run against mocked responses, use `make test_mock`. Finally, the commit also unifies the several test options in a unique environmental variable called `QISKIT_TESTS` (in `tests/python/_test_options.py`). These are the main equivalences but the set of options is described in the developer introduction [2]: - `SKIP_SLOW_TESTS=False` is now achieved by `QISKIT_TESTS=run_slow` - `SKIP_ONLINE_TESTS=1` is now achieved by `QISKIT_TESTS=skip_online` [2] https://github.com/Qiskit/qiskit-terra/blob/master/doc/dev_introduction.rst#testing-options
2018-08-21 02:42:23 +08:00
Erick/discovery profiling (#68) * get list of circuit names in program * Enable len(circuit), circuit[n], and len(register). This allows circuits and registers to behave more like lists. len(circuit): number of instructions in circuit circuit[n]: nth instruction added to circuit len(register): size of register * Add profiling facility. Test for QasmSimulator. Makefile modified to allow profiling with python's unittest discovery facility. Test files are in same directory as the module they test. Make targets changed so that make test: looks for tests matching "test*.py" and "*_test.py". make profile: looks for unittest profiling matching "*_profile.py" To avoid file pollution discovery matching "*_profile.py" pattern gets routed to test module by generating a profiling suite of tests. This is done with unittest's "load_tests" facility. * Fix test to work with jsonbackend. Also, fixed warnings during test about unclosed file in lexer.
2017-07-05 21:05:19 +08:00
profile:
Add "make test_ci" target for CIs, simplify "make test" (#1745) * Add test_ci make target, revert make test Add a new "test_ci" target to the Makefile, aimed at being used by the CIs. Update the "test" family of targets in order to revert back to the behaviour that involves less overhead and complexity for the users. * Update travis in order to use test_ci * Add documentation about test_ci target
2019-02-06 05:28:16 +08:00
python3 -m unittest discover -p "profile*.py" -v
sphinx autodoc setup. Documents the project source code from python docstrings. Run "make doc" from the top level to generate the html in doc/_build/html.
2017-07-27 00:32:54 +08:00
Coverage of the testsuite (#297) * coverage rule in Makefile * coverage in cmake * clean coverage rule * it looks like there is a proper way to remove the coverage data * cmake: coverage_erase * Add coverage target to cmake, fix typo * Fix travis osx brew python (now upgrade)
2018-03-06 03:38:13 +08:00
coverage:
Add "make test_ci" target for CIs, simplify "make test" (#1745) * Add test_ci make target, revert make test Add a new "test_ci" target to the Makefile, aimed at being used by the CIs. Update the "test" family of targets in order to revert back to the behaviour that involves less overhead and complexity for the users. * Update travis in order to use test_ci * Add documentation about test_ci target
2019-02-06 05:28:16 +08:00
coverage3 run --source qiskit -m unittest discover -s test -q
Coverage of the testsuite (#297) * coverage rule in Makefile * coverage in cmake * clean coverage rule * it looks like there is a proper way to remove the coverage data * cmake: coverage_erase * Add coverage target to cmake, fix typo * Fix travis osx brew python (now upgrade)
2018-03-06 03:38:13 +08:00
coverage3 report
sphinx autodoc setup. Documents the project source code from python docstrings. Run "make doc" from the top level to generate the html in doc/_build/html.
2017-07-27 00:32:54 +08:00
doc:
Customize public qiskit apidoc documentation Replace the full apidoc automatically generated documentation with a set of pages that display only the public objects (using the class path specified by the main import: ie "qiskit.QuantumProgram" instead of "qistkit._quantumprogram.QuantumProgram") via custom templates using the better-apidoc package.
2017-09-13 00:10:38 +08:00
export PYTHONPATH=$(PWD); \
Adding german translation of doc files (#592) * creating conf.py for German language * initial German translation * minor fixes and typos * fixing typos and cleaning * adding DE version * fixing formatting issues * fixing formatting issues * formatting issues * first DE version of index.rst * fixing typos * adding German translation de * adding German translation * adding German intro translation * fixing minor typo * adding German translation of real backend example * minor typo * adding German translation of getting started * adding German translation of dev_introduction.rst * fixing minor typos and beautification * fixing title underline * fixing image ref * fixing broken links * fixing broken reference * fixing formatting issue * add line in changelog * remove note on downgrade requirements according to main doc * Update CHANGELOG.rst * minor fixes
2018-06-29 06:22:36 +08:00
for LANGUAGE in "." "de" "ja"; do \
Sphinx docstring cleanup, and include qiskit.tools (#1543) * Docstrings fixes for removing Sphinx warnings * Fix splitting of TOC entries * Include qiskit/tools in sphinx documentation
2018-12-19 04:36:33 +08:00
better-apidoc -f -o doc/$$LANGUAGE/_autodoc --no-toc --private --maxdepth=5 --separate --templates=doc/_templates/better-apidoc qiskit "qiskit/extensions/standard/[a-z]*"; \
Added japanese doc for installation of QISKit (#140) * Added japanese doc * Update Make and structure to allow multiple langs Update the Makefile "doc" target to build both the English and the Japanese versions, in separate directories, and the "clean" target to cleanup the autodoc documentation. Add a "conf.py" file to the "doc/ja" folder that modifies the relevant variables, as Sphinx uses that folder as the root document folder when building the Japanese version. * Fix missing "install" reference on ja sphinx docs * Update sphinx doc deploy script for Japanese Add the Japanese sphinx produced directory to the Github pages deploy script. * Fix typo and extra line in Makefile
2017-11-09 01:13:43 +08:00
sphinx-autogen -t doc/_templates doc/$$LANGUAGE/_autodoc/*; \
make -C doc -e BUILDDIR="_build/$$LANGUAGE" -e SOURCEDIR="./$$LANGUAGE" html; \
done
sphinx autodoc setup. Documents the project source code from python docstrings. Run "make doc" from the top level to generate the html in doc/_build/html.
2017-07-27 00:32:54 +08:00
Coverage of the testsuite (#297) * coverage rule in Makefile * coverage in cmake * clean coverage rule * it looks like there is a proper way to remove the coverage data * cmake: coverage_erase * Add coverage target to cmake, fix typo * Fix travis osx brew python (now upgrade)
2018-03-06 03:38:13 +08:00
coverage_erase:
coverage erase
clean: coverage_erase
sphinx autodoc setup. Documents the project source code from python docstrings. Run "make doc" from the top level to generate the html in doc/_build/html.
2017-07-27 00:32:54 +08:00
make -C doc clean
Adding german translation of doc files (#592) * creating conf.py for German language * initial German translation * minor fixes and typos * fixing typos and cleaning * adding DE version * fixing formatting issues * fixing formatting issues * formatting issues * first DE version of index.rst * fixing typos * adding German translation de * adding German translation * adding German intro translation * fixing minor typo * adding German translation of real backend example * minor typo * adding German translation of getting started * adding German translation of dev_introduction.rst * fixing minor typos and beautification * fixing title underline * fixing image ref * fixing broken links * fixing broken reference * fixing formatting issue * add line in changelog * remove note on downgrade requirements according to main doc * Update CHANGELOG.rst * minor fixes
2018-06-29 06:22:36 +08:00
make -C doc -e BUILDDIR="_build/de" -e SOURCEDIR="./de" clean
Added japanese doc for installation of QISKit (#140) * Added japanese doc * Update Make and structure to allow multiple langs Update the Makefile "doc" target to build both the English and the Japanese versions, in separate directories, and the "clean" target to cleanup the autodoc documentation. Add a "conf.py" file to the "doc/ja" folder that modifies the relevant variables, as Sphinx uses that folder as the root document folder when building the Japanese version. * Fix missing "install" reference on ja sphinx docs * Update sphinx doc deploy script for Japanese Add the Japanese sphinx produced directory to the Github pages deploy script. * Fix typo and extra line in Makefile
2017-11-09 01:13:43 +08:00
make -C doc -e BUILDDIR="_build/ja" -e SOURCEDIR="./ja" clean
Test fixes: subtests, names, make clean Minor fixes for the tests: * use subtests in several places, for easier identification of the failing assertions in loops. * style, variable names, and typo fixes. * add cleanup of the files generated by the tests to the `make clean` target.
2018-01-17 03:44:47 +08:00
rm -f test/python/test_latex_drawer.tex test/python/test_qasm_python_simulator.pdf \
test/python/test_save.json test/python/test_teleport.tex