diff --git a/README.md b/README.md index e0452838d536c5b6a97a107add26230f92fc4bc6..2185be072b7a94570df8c42527bfc63fdef772f7 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,8 @@ The following packages are required in order to build the library: - pybind11 - pyside2 - qtpy - - scipy - setuptools + - setuptools_scm To build a binary distribution, the following additional packages are required: @@ -36,13 +36,20 @@ To build a binary distribution, the following additional packages are required: To run the test suite, the following additional packages are required: -- Python: +- Python (install with `pip install -r requirements_test.txt`): - pytest + - pytest-qt + - pytest-mpl - pytest-cov (for testing with coverage) + - pytest-xvfb (for testing without showing windows on Linux) + - pytest-xdist (for parallel testing) To generate the documentation, the following additional packages are required: -- doxygen +- Python (install with `pip install -r requirements_doc.txt`): + - sphinx + - furo + - numpydoc ### Using CMake directly @@ -147,18 +154,25 @@ pytest #### Test with coverage ``` -pytest --cov=b_asic --cov-report html test +pytest --cov=b_asic --cov-report=html test +``` + +#### Test including plots + +``` +pytest --mpl ``` + ### Generating documentation -In `B-ASIC`: +In `B-ASIC/docs_sphinx`: ``` -doxygen +make html ``` -The output gets written to `B-ASIC/doc`. +The output gets written to `B-ASIC/docs_sphinx/_build`. ## Usage @@ -167,7 +181,7 @@ How to build and use the library as a user. ### Installation ``` -pip install b_asic +pip install . ``` ### Importing diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..cba8d8860740c8cc71720b2c8640c6b4d47ca4e2 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +setuptools_scm diff --git a/requirements_doc.txt b/requirements_doc.txt new file mode 100644 index 0000000000000000000000000000000000000000..bd3577ef6068ff2e6a0c87dd30700d4c2d7a8bab --- /dev/null +++ b/requirements_doc.txt @@ -0,0 +1,3 @@ +sphinx +furo +numpydoc diff --git a/requirements_test.txt b/requirements_test.txt new file mode 100644 index 0000000000000000000000000000000000000000..64543e503881b8b3e3d227bc2af1c259e8403256 --- /dev/null +++ b/requirements_test.txt @@ -0,0 +1,6 @@ +pytest +pytest-cov +pytest-qt +pytest-mpl +pytest-xvfb +pytest-xdist