Skip to content

Commit 517604c

Browse files
committed
doc: add documentation for the new example
1 parent 090e9c3 commit 517604c

3 files changed

Lines changed: 14 additions & 0 deletions

File tree

‎docs/examples/README‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,8 @@ future versions.
159159
recipes to be written with less code. This is not the same as a
160160
full-featured scripting interface, but rather somewhere in between a
161161
scripting interface and the API.
162+
163+
- parallel_refinement.py\_
164+
This demonstrates fitting the fcc nickel structure to measured PDF data,
165+
and compares running several such refinements sequentially versus in
166+
parallel using the multiprocessing module.

‎docs/source/examples.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Examples
2727
.. _nppdfsas.py: examples/nppdfsas.html
2828
.. _interface.py: examples/interface.html
2929
.. _simplerecipe.py: examples/simplerecipe.html
30+
.. _parallel_refinement.py: examples/parallel_refinement.html
3031

3132

3233
Files
@@ -54,3 +55,4 @@ Files
5455
examples/nppdfsas.rst
5556
examples/interface.rst
5657
examples/simplerecipe.rst
58+
examples/parallel_refinement.rst
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _parallel_refinement.py:
2+
3+
========================
4+
parallel_refinement.py
5+
========================
6+
7+
.. literalinclude:: ../../examples/parallel_refinement.py

0 commit comments

Comments
 (0)