Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 20 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,26 @@ We periodically release the contents of `develop` to `master`. Contact the team

### Blogs

If you develop a new feature, please consider writing a blog for the [QMCPy documentation](https://qmcsoftware.github.io/QMCSoftware/) including a brief summary of the mathematical rationale, key evidence (tests, benchmarks, or references), and examples.
Blog prose is maintained in
[`QMCSoftware/QMCSoftware.github.io`](https://github.com/QMCSoftware/QMCSoftware.github.io),
not in this repository's MkDocs documentation site. Propose and publish blog
posts there; published articles appear on the
[QMCSoftware Blog](https://qmcsoftware.org/blogs/).

Runnable examples remain in this repository. For every article backed by a
notebook:

1. Keep the executable notebook under `demos/` as the reproducible source and
link the article to that exact repository path. Moving the article prose to
the website is not a reason to delete its notebook.
2. Edit and execute the notebook in the QMCPy development environment, from its
containing directory when it uses relative imports or helper files.
3. Add or update the matching `test/booktests/tb_*.py` test and run that focused
test before updating the website article. See
[`test/booktests/README.md`](https://github.com/QMCSoftware/QMCSoftware/blob/develop/test/booktests/README.md)
for commands.
4. Update the website article separately, then verify that its source-notebook
link still resolves.


## Installation
Expand Down
27 changes: 26 additions & 1 deletion demos/demo_resume_data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ This folder contains notebooks and helper scripts for demonstrating QMCPy's resu

- `accuracy_and_resume.ipynb`: Long-form walkthrough of the feature.

- `resume_examples.ipynb`: Compact how-to for the feature.
- `resume_examples.ipynb`: Compact, recipe-style walkthrough of the resume
workflow.

- `Iteration_Log_Tolerance_Demo.ipynb`: Focused demonstration of tolerance
changes and the iteration log.

- `check_resume.py`: Runs a cross-method comparison of:
- a loose run followed by resume with a tighter tolerance
Expand All @@ -23,6 +27,27 @@ This folder contains notebooks and helper scripts for demonstrating QMCPy's resu
- `resume_util.py`: Shared helpers for the resume demo scripts, including case execution, log formatting, and text-report generation.

- `output/`: Generated reports and checkpoint files created when you run the notebooks or `check_resume.py`. These artifacts are intentionally not tracked in git.

## Reproducing the Website Articles

The website articles on the
[resume feature](https://qmcsoftware.org/blogs/resume-feature/) and
[iteration logs](https://qmcsoftware.org/blogs/iteration-log/) summarize the
material, while the three notebooks above are the executable sources. To check
an update, execute all cells in the relevant notebook using the QMCPy
development environment, then run its focused booktest from the repository
root:

```bash
cd test/booktests
python -m pytest tb_accuracy_and_resume.py \
tb_resume_examples.py \
tb_Iteration_Log_Tolerance_Demo.py -v
```

Keep the notebook, any local helper files, and its `tb_*.py` booktest together
when the corresponding website article changes. The article should link back to
the notebook in this directory so readers can rerun the complete example.

## Generated Reports

Expand Down
2 changes: 1 addition & 1 deletion demos/scipywrapper_dependence_custom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ From the top level of the QMCSoftware repo, the pieces for this project are:
- `demos/scipywrapper_dependence_custom/README.md`
This file.

- `docs/blogs/scipywrapper/index.md`
- [SciPyWrapper article on the QMCSoftware Blog](https://qmcsoftware.org/blogs/scipywrapper/)
Blog describing the project at a higher level.

- `test/test_scipy_wrapper_custom.py`
Expand Down
Binary file not shown.
148 changes: 0 additions & 148 deletions docs/blogs/a-qmcpy-quick-start/index.md

This file was deleted.

Binary file not shown.
Binary file not shown.
94 changes: 0 additions & 94 deletions docs/blogs/accelerating-qmcpy-notebook-tests-with-parsl/index.md

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Loading