Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
2cb3a49
tandardize test filenames and improve formatter diagnostics
sou-cheng-choi Aug 31, 2026
b7647cf
Respond to comments from gitHub-code-quality
sou-cheng-choi Aug 31, 2026
f46f7f3
Fix Torch fallback test arguments
sou-cheng-choi Aug 31, 2026
26f91c8
Guidelines when a test spans >1 areas
sou-cheng-choi Sep 4, 2026
3ff2e4a
Merge branch 'develop' into develop_choi
sou-cheng-choi Sep 4, 2026
f7b0e1c
Better format
sou-cheng-choi Sep 4, 2026
6cc1dc6
+ check docstring tools
sou-cheng-choi Sep 4, 2026
ae6b9b0
Add empty lines in output
sou-cheng-choi Sep 4, 2026
8ef9f27
Use pydoclint
sou-cheng-choi Sep 4, 2026
b6f6046
Merge remote-tracking branch 'origin/develop' into develop_choi
sou-cheng-choi Sep 4, 2026
8d4358c
Turn test/test_sr_colab_notebooks.py into object class
sou-cheng-choi Sep 4, 2026
df168c7
add make check_test_style to alltests.yml
sou-cheng-choi Sep 4, 2026
1f66c70
Turn Numpy doc to Google doc
sou-cheng-choi Sep 4, 2026
424ad00
Change to Google style
sou-cheng-choi Sep 4, 2026
1932273
Respond to github-code-quality Bot comment
sou-cheng-choi Sep 4, 2026
5388464
Add arg type following Google doc style
sou-cheng-choi Sep 5, 2026
b81d548
mkae format_google_docstrings
sou-cheng-choi Sep 5, 2026
8db3ee7
Fixed the doctest failure due to white spaces
sou-cheng-choi Sep 6, 2026
81afce5
Introduce tool for converting assert statements
sou-cheng-choi Sep 6, 2026
e4ae5dd
assert -> AssertionError
sou-cheng-choi Sep 6, 2026
a03c04d
Add tools for Google style doc for input and output parameters of pub…
sou-cheng-choi Sep 6, 2026
4202569
Merge branch 'develop' into develop_choi
sou-cheng-choi Sep 7, 2026
b6eae55
Restore return types
sou-cheng-choi Sep 7, 2026
ac76efc
Change names
sou-cheng-choi Sep 7, 2026
7cb819d
Restore return types
sou-cheng-choi Sep 7, 2026
087b0f0
Reduce output
sou-cheng-choi Sep 7, 2026
5d82301
Minor updates
sou-cheng-choi Sep 7, 2026
14d85d6
Fix assert statements
sou-cheng-choi Sep 7, 2026
6ae1662
Minor changes
sou-cheng-choi Sep 7, 2026
df0befb
Fix indentation issues in docstrings
sou-cheng-choi Sep 7, 2026
5e9bf3c
Minor changes
sou-cheng-choi Sep 7, 2026
bc8f9c3
Organize makefile targets
sou-cheng-choi Sep 7, 2026
46a1246
Add sub-targets to make format and check
sou-cheng-choi Sep 8, 2026
381da37
Convert assert to AssertionError
sou-cheng-choi Sep 8, 2026
130840c
Enhanced Makefile
sou-cheng-choi Sep 8, 2026
24299ef
Enhance docstrings
sou-cheng-choi Sep 8, 2026
04a12ac
Better docstrings
sou-cheng-choi Sep 8, 2026
ef55930
Better docstrings
sou-cheng-choi Sep 8, 2026
90d105a
Fix typos
sou-cheng-choi Sep 8, 2026
be8afbf
Fix "make doc" warnings
sou-cheng-choi Sep 8, 2026
9c0b5b1
Add missing docstrings. Enhance docstrings format.
sou-cheng-choi Sep 8, 2026
526f980
Add type hints to public APIs
sou-cheng-choi Sep 9, 2026
057d8dc
Add type hints
sou-cheng-choi Sep 9, 2026
0f94133
`i.e. ` -> `i.e., `
sou-cheng-choi Sep 9, 2026
f5c0dae
remove redundant spaces in docstrings in "**References: **"
sou-cheng-choi Sep 9, 2026
f37c6ff
Adjust spaces and minor issues in docstrings
sou-cheng-choi Sep 9, 2026
8f7af6e
Better warning in docstrings
sou-cheng-choi Sep 9, 2026
8490235
Better type hints in docstrings
sou-cheng-choi Sep 9, 2026
102c5ec
Add a demo and improve output clarity
sou-cheng-choi Sep 10, 2026
cba037a
Update return type and description in docstring
sou-cheng-choi Sep 10, 2026
6a93dbe
Removed commented out imports
sou-cheng-choi Sep 11, 2026
eea30ae
Fix remote doctests on ubuntu
sou-cheng-choi Sep 11, 2026
35cf45f
Fix obvious error
sou-cheng-choi Sep 11, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/alltests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,15 @@ jobs:
run: |
make check_colab_notebooks
make check_colab_notebooks_smoke
- name: Check test-suite conventions (Linux)
if: runner.os == 'Linux'
shell: bash -l {0}
run: |
set -e
make check_test_style STRICT=--strict
python -m pip install -q "pydoclint>=0.5.0"
make check_docstring # informational (exits 0 without STRICT)
make check_baseline # real gate: docstring/pydoclint/annotation issues must not increase
# -----------------------------------------------------------
# Install minimal LaTeX required by Jupyter notebooks (OS-specific)
# -----------------------------------------------------------
Expand Down
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,10 @@ make tests

Please see the targets in the makefile for more granular control over tests.

### Test file layout

Unit tests live flat in `test/`, named `test_<area>_<topic>.py` where `<area>` is a short code for the `qmcpy` subpackage under test (`tm` true_measure, `dd` discrete_distribution, `sc` stopping_criterion, `ig` integrand, ...) or a cross-cutting bucket (`ee`, `sr`). So `pytest test/ -k test_tm_` runs every true-measure test. A test that spans two areas goes under the component actually under test, with the other named in `<topic>` (e.g. `test_sc_cubbayes_kernels.py`); use `ee` only when neither side is the clear subject, and never coin a new code — `STRICT=--strict` rejects anything outside the table. New files should also be written as a `unittest.TestCase` subclass rather than bare `def test_*` functions. `make check_test_style` lists any file that breaks either convention (informational; also runs inside `make format`; `STRICT=--strict` makes it fail). The full area table is in [`test/README.md`](test/README.md#test-file-organization).

## Documentation

### Ensure `pyreverse` Is On Your PATH
Expand Down
2 changes: 1 addition & 1 deletion demos/acceptance_rejection.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@
"$$D^*_N(\\psi) = \\sup_{t \\in [0,1]} \\left| \\frac{\\#\\{i : x_i \\leq t\\}}{N} - \\frac{1}{C}\\int_0^t \\psi(x)\\,dx \\right|$$\n",
"\n",
"Theorem 1 of Zhu & Dick (2014) predicts:\n",
"- **Sobol driver (DAR):** $D^*_N = O(N^{-1/s})$ with $s=2$ for $d=1$, i.e. $O(N^{-1/2})$ in the worst case — but empirically faster due to the $\\log N$ factors.\n",
"- **Sobol driver (DAR):** $D^*_N = O(N^{-1/s})$ with $s=2$ for $d=1$, i.e., $O(N^{-1/2})$ in the worst case — but empirically faster due to the $\\log N$ factors.\n",
"- **Random driver (standard A-R):** $D^*_N = O(N^{-1/2})$ always.\n",
"\n",
"The plot below measures this empirically for $\\psi(x) = 2x$ on $[0,1]$, where the CDF is $F(t) = t^2$ and $C = 1$."
Expand Down
2 changes: 1 addition & 1 deletion demos/lebesgue_integration.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{
"cell_type": "markdown",
"metadata": {},
"source": "# QMCPy for Lebesgue Integration\nThis notebook will give examples of how to use QMCPy for integration problems that are not defined in terms of a standard measure. i.e. Uniform or Gaussian. "
"source": "# QMCPy for Lebesgue Integration\nThis notebook will give examples of how to use QMCPy for integration problems that are not defined in terms of a standard measure. i.e., Uniform or Gaussian. "
},
{
"cell_type": "markdown",
Expand Down
Loading
Loading