diff --git a/docs/examples/data/Ag_nyquist_qmax30.gr b/docs/examples/data/Ag-nyquist-qmax30.gr similarity index 100% rename from docs/examples/data/Ag_nyquist_qmax30.gr rename to docs/examples/data/Ag-nyquist-qmax30.gr diff --git a/docs/examples/data/C60_fine_qmax21.gr b/docs/examples/data/C60-fine-qmax21.gr similarity index 100% rename from docs/examples/data/C60_fine_qmax21.gr rename to docs/examples/data/C60-fine-qmax21.gr diff --git a/docs/examples/data/TiO2_fine_qmax26.gr b/docs/examples/data/TiO2-fine-qmax26.gr similarity index 100% rename from docs/examples/data/TiO2_fine_qmax26.gr rename to docs/examples/data/TiO2-fine-qmax26.gr diff --git a/docs/examples/extract_single_peak.py b/docs/examples/extract-single-peak.py similarity index 90% rename from docs/examples/extract_single_peak.py rename to docs/examples/extract-single-peak.py index 5004172..873ae62 100644 --- a/docs/examples/extract_single_peak.py +++ b/docs/examples/extract-single-peak.py @@ -19,9 +19,9 @@ parameters, running peak extraction, and saving the results. This script is equivalent to running -srmise data/Ag_nyquist_qmax30.gr --range 2. 3.5 \ - --baseline "Polynomial(degree=1)" --save output/extract_single_peak.srmise \ - --pwa output/extract_single_peak.pwa --plot +srmise data/Ag-nyquist-qmax30.gr --range 2. 3.5 \ + --baseline "Polynomial(degree=1)" --save output/extract-single-peak.srmise \ + --pwa output/extract-single-peak.pwa --plot at the command line. """ @@ -39,7 +39,7 @@ def run(plot=True): ppe = PDFPeakExtraction() # Load the PDF from a file - ppe.loadpdf("data/Ag_nyquist_qmax30.gr") + ppe.loadpdf("data/Ag-nyquist-qmax30.gr") # Set up extraction parameters. # For convenience, we add all parameters to a dictionary before passing them @@ -74,8 +74,8 @@ def run(plot=True): # half-maximum), and area of extracted peaks. The reported values # are for Gaussians in the radial distribution function (RDF) corresponding # to this PDF. - ppe.write("output/extract_single_peak.srmise") - ppe.writepwa("output/extract_single_peak.pwa") + ppe.write("output/extract-single-peak.srmise") + ppe.writepwa("output/extract-single-peak.pwa") # Plot results. # Display plot of extracted peak. It is also possible to plot an existing diff --git a/docs/examples/fit_initial.py b/docs/examples/fit-initial.py similarity index 97% rename from docs/examples/fit_initial.py rename to docs/examples/fit-initial.py index 57af2d7..571c4d9 100644 --- a/docs/examples/fit_initial.py +++ b/docs/examples/fit-initial.py @@ -34,7 +34,7 @@ def run(plot=True): # Initialize peak extraction ppe = PDFPeakExtraction() - ppe.loadpdf("data/C60_fine_qmax21.gr") + ppe.loadpdf("data/C60-fine-qmax21.gr") # Set up interpolated baseline. # The FromSequence baseline creates an interpolated baseline from provided @@ -98,8 +98,8 @@ def run(plot=True): ppe.fit() # Save results - ppe.write("output/fit_initial.srmise") - ppe.writepwa("output/fit_initial.pwa") + ppe.write("output/fit-initial.srmise") + ppe.writepwa("output/fit-initial.pwa") if plot: plt.figure() diff --git a/docs/examples/images/extract_single_peak1.png b/docs/examples/images/extract-single-peak1.png similarity index 100% rename from docs/examples/images/extract_single_peak1.png rename to docs/examples/images/extract-single-peak1.png diff --git a/docs/examples/images/extract_single_peak2.png b/docs/examples/images/extract-single-peak2.png similarity index 100% rename from docs/examples/images/extract_single_peak2.png rename to docs/examples/images/extract-single-peak2.png diff --git a/docs/examples/images/extract_single_peak3.png b/docs/examples/images/extract-single-peak3.png similarity index 100% rename from docs/examples/images/extract_single_peak3.png rename to docs/examples/images/extract-single-peak3.png diff --git a/docs/examples/images/fit_initial1.png b/docs/examples/images/fit-initial1.png similarity index 100% rename from docs/examples/images/fit_initial1.png rename to docs/examples/images/fit-initial1.png diff --git a/docs/examples/images/fit_initial2.png b/docs/examples/images/fit-initial2.png similarity index 100% rename from docs/examples/images/fit_initial2.png rename to docs/examples/images/fit-initial2.png diff --git a/docs/examples/images/parameter_summary1.png b/docs/examples/images/parameter-summary1.png similarity index 100% rename from docs/examples/images/parameter_summary1.png rename to docs/examples/images/parameter-summary1.png diff --git a/docs/examples/images/parameter_summary2.png b/docs/examples/images/parameter-summary2.png similarity index 100% rename from docs/examples/images/parameter_summary2.png rename to docs/examples/images/parameter-summary2.png diff --git a/docs/examples/images/parameter_summary3.png b/docs/examples/images/parameter-summary3.png similarity index 100% rename from docs/examples/images/parameter_summary3.png rename to docs/examples/images/parameter-summary3.png diff --git a/docs/examples/images/parameter_summary4.png b/docs/examples/images/parameter-summary4.png similarity index 100% rename from docs/examples/images/parameter_summary4.png rename to docs/examples/images/parameter-summary4.png diff --git a/docs/examples/images/query_results1.png b/docs/examples/images/query-results1.png similarity index 100% rename from docs/examples/images/query_results1.png rename to docs/examples/images/query-results1.png diff --git a/docs/examples/images/query_results2.png b/docs/examples/images/query-results2.png similarity index 100% rename from docs/examples/images/query_results2.png rename to docs/examples/images/query-results2.png diff --git a/docs/examples/images/query_results3.png b/docs/examples/images/query-results3.png similarity index 100% rename from docs/examples/images/query_results3.png rename to docs/examples/images/query-results3.png diff --git a/docs/examples/multimodel_known_dG1.py b/docs/examples/multimodel-known-dG1.py similarity index 92% rename from docs/examples/multimodel_known_dG1.py rename to docs/examples/multimodel-known-dG1.py index 3d52ec0..a8eb04f 100644 --- a/docs/examples/multimodel_known_dG1.py +++ b/docs/examples/multimodel-known-dG1.py @@ -52,7 +52,7 @@ def run(plot=True): # Initialize peak extraction from saved trial ppe = PDFPeakExtraction() - ppe.read("output/query_results.srmise") + ppe.read("output/query-results.srmise") ppe.clearcalc() # Set up extraction parameters @@ -78,13 +78,13 @@ def run(plot=True): ms.run(dgs) # Save results - # The file known_dG_models.dat saves the models generated above. The file - # known_dG_aics.dat saves the value of the AIC of each model when evaluated + # The file known-dG-models.dat saves the models generated above. The file + # known-dG-aics.dat saves the value of the AIC of each model when evaluated # on a Nyquist-sampled grid using each of the dg values used to generate # the models in the first place. dr = np.pi / ppe.qmax - ms.save("output/known_dG_models.dat") - ms.makeaics(dgs, dr, filename="output/known_dG_aics.dat") + ms.save("output/known-dG-models.dat") + ms.makeaics(dgs, dr, filename="output/known-dG-aics.dat") if __name__ == "__main__": diff --git a/docs/examples/multimodel_known_dG2.py b/docs/examples/multimodel-known-dG2.py similarity index 98% rename from docs/examples/multimodel_known_dG2.py rename to docs/examples/multimodel-known-dG2.py index 142df83..b9c4a7d 100644 --- a/docs/examples/multimodel_known_dG2.py +++ b/docs/examples/multimodel-known-dG2.py @@ -65,8 +65,8 @@ def run(plot=True): # Create multimodeling object and load diffpy.srmise results from file. ms = MultimodelSelection() - ms.load("output/known_dG_models.dat") - ms.loadaics("output/known_dG_aics.dat") + ms.load("output/known-dG-models.dat") + ms.loadaics("output/known-dG-aics.dat") # Use Nyquist sampling # Standard AIC analysis assumes the data have independent uncertainties. diff --git a/docs/examples/multimodel_unknown_dG1.py b/docs/examples/multimodel-unknown-dG1.py similarity index 96% rename from docs/examples/multimodel_unknown_dG1.py rename to docs/examples/multimodel-unknown-dG1.py index 45324ee..f5411c6 100644 --- a/docs/examples/multimodel_unknown_dG1.py +++ b/docs/examples/multimodel-unknown-dG1.py @@ -52,7 +52,7 @@ def run(plot=True): # Initialize peak extraction ppe = PDFPeakExtraction() - ppe.loadpdf("data/C60_fine_qmax21.gr") + ppe.loadpdf("data/C60-fine-qmax21.gr") # Set up extraction parameters # The FromSequence baseline interpolates (r, G(r)) values read from a @@ -87,8 +87,8 @@ def run(plot=True): # on a Nyquist-sampled grid using each of the dg values used to generate # the models in the first place. dr = np.pi / ppe.qmax - ms.save("output/unknown_dG_models.dat") - ms.makeaics(dgs, dr, filename="output/unknown_dG_aics.dat") + ms.save("output/unknown-dG-models.dat") + ms.makeaics(dgs, dr, filename="output/unknown-dG-aics.dat") if __name__ == "__main__": diff --git a/docs/examples/multimodel_unknown_dG2.py b/docs/examples/multimodel-unknown-dG2.py similarity index 98% rename from docs/examples/multimodel_unknown_dG2.py rename to docs/examples/multimodel-unknown-dG2.py index c4bbef4..7e56a4f 100644 --- a/docs/examples/multimodel_unknown_dG2.py +++ b/docs/examples/multimodel-unknown-dG2.py @@ -80,8 +80,8 @@ def run(plot=True): # Create multimodeling object and load diffpy.srmise results from file. ms = MultimodelSelection() - ms.load("output/unknown_dG_models.dat") - ms.loadaics("output/unknown_dG_aics.dat") + ms.load("output/unknown-dG-models.dat") + ms.loadaics("output/unknown-dG-aics.dat") # Use Nyquist sampling # Standard AIC analysis assumes the data have independent uncertainties. diff --git a/docs/examples/output/extract_single_peak.pwa b/docs/examples/output/extract-single-peak.pwa similarity index 100% rename from docs/examples/output/extract_single_peak.pwa rename to docs/examples/output/extract-single-peak.pwa diff --git a/docs/examples/output/extract_single_peak.srmise b/docs/examples/output/extract-single-peak.srmise similarity index 100% rename from docs/examples/output/extract_single_peak.srmise rename to docs/examples/output/extract-single-peak.srmise diff --git a/docs/examples/output/fit_initial.pwa b/docs/examples/output/fit-initial.pwa similarity index 100% rename from docs/examples/output/fit_initial.pwa rename to docs/examples/output/fit-initial.pwa diff --git a/docs/examples/output/fit_initial.srmise b/docs/examples/output/fit-initial.srmise similarity index 100% rename from docs/examples/output/fit_initial.srmise rename to docs/examples/output/fit-initial.srmise diff --git a/docs/examples/output/known_dG_aics.dat b/docs/examples/output/known-dG-aics.dat similarity index 100% rename from docs/examples/output/known_dG_aics.dat rename to docs/examples/output/known-dG-aics.dat diff --git a/docs/examples/output/known_dG_m0.pwa b/docs/examples/output/known-dG-m0.pwa similarity index 100% rename from docs/examples/output/known_dG_m0.pwa rename to docs/examples/output/known-dG-m0.pwa diff --git a/docs/examples/output/known_dG_m1.pwa b/docs/examples/output/known-dG-m1.pwa similarity index 100% rename from docs/examples/output/known_dG_m1.pwa rename to docs/examples/output/known-dG-m1.pwa diff --git a/docs/examples/output/known_dG_m12.pwa b/docs/examples/output/known-dG-m12.pwa similarity index 100% rename from docs/examples/output/known_dG_m12.pwa rename to docs/examples/output/known-dG-m12.pwa diff --git a/docs/examples/output/known_dG_m8.pwa b/docs/examples/output/known-dG-m8.pwa similarity index 100% rename from docs/examples/output/known_dG_m8.pwa rename to docs/examples/output/known-dG-m8.pwa diff --git a/docs/examples/output/known_dG_models.dat b/docs/examples/output/known-dG-models.dat similarity index 100% rename from docs/examples/output/known_dG_models.dat rename to docs/examples/output/known-dG-models.dat diff --git a/docs/examples/output/parameter_summary.pwa b/docs/examples/output/parameter-summary.pwa similarity index 100% rename from docs/examples/output/parameter_summary.pwa rename to docs/examples/output/parameter-summary.pwa diff --git a/docs/examples/output/parameter_summary.srmise b/docs/examples/output/parameter-summary.srmise similarity index 100% rename from docs/examples/output/parameter_summary.srmise rename to docs/examples/output/parameter-summary.srmise diff --git a/docs/examples/output/query_results.pwa b/docs/examples/output/query-results.pwa similarity index 100% rename from docs/examples/output/query_results.pwa rename to docs/examples/output/query-results.pwa diff --git a/docs/examples/output/query_results.srmise b/docs/examples/output/query-results.srmise similarity index 100% rename from docs/examples/output/query_results.srmise rename to docs/examples/output/query-results.srmise diff --git a/docs/examples/output/unknown_dG_aics.dat b/docs/examples/output/unknown-dG-aics.dat similarity index 100% rename from docs/examples/output/unknown_dG_aics.dat rename to docs/examples/output/unknown-dG-aics.dat diff --git a/docs/examples/output/unknown_dG_m11.pwa b/docs/examples/output/unknown-dG-m11.pwa similarity index 100% rename from docs/examples/output/unknown_dG_m11.pwa rename to docs/examples/output/unknown-dG-m11.pwa diff --git a/docs/examples/output/unknown_dG_m17.pwa b/docs/examples/output/unknown-dG-m17.pwa similarity index 100% rename from docs/examples/output/unknown_dG_m17.pwa rename to docs/examples/output/unknown-dG-m17.pwa diff --git a/docs/examples/output/unknown_dG_m18.pwa b/docs/examples/output/unknown-dG-m18.pwa similarity index 100% rename from docs/examples/output/unknown_dG_m18.pwa rename to docs/examples/output/unknown-dG-m18.pwa diff --git a/docs/examples/output/unknown_dG_m5.pwa b/docs/examples/output/unknown-dG-m5.pwa similarity index 100% rename from docs/examples/output/unknown_dG_m5.pwa rename to docs/examples/output/unknown-dG-m5.pwa diff --git a/docs/examples/output/unknown_dG_m7.pwa b/docs/examples/output/unknown-dG-m7.pwa similarity index 100% rename from docs/examples/output/unknown_dG_m7.pwa rename to docs/examples/output/unknown-dG-m7.pwa diff --git a/docs/examples/output/unknown_dG_models.dat b/docs/examples/output/unknown-dG-models.dat similarity index 100% rename from docs/examples/output/unknown_dG_models.dat rename to docs/examples/output/unknown-dG-models.dat diff --git a/docs/examples/parameter_summary.py b/docs/examples/parameter-summary.py similarity index 98% rename from docs/examples/parameter_summary.py rename to docs/examples/parameter-summary.py index b135d82..7a11243 100644 --- a/docs/examples/parameter_summary.py +++ b/docs/examples/parameter-summary.py @@ -43,7 +43,7 @@ def run(plot=True): ppe = PDFPeakExtraction() # Load the PDF from a file - ppe.loadpdf("data/TiO2_fine_qmax26.gr") + ppe.loadpdf("data/TiO2-fine-qmax26.gr") # Set up extraction parameters. # In this section we'll examine the major extraction parameters in detail. @@ -220,8 +220,8 @@ def run(plot=True): # half-maximum), and area of of extracted peaks. The reported values # are for Gaussians in the radial distribution function (RDF) corresponding # to this PDF. - ppe.write("output/parameter_summary.srmise") - ppe.writepwa("output/parameter_summary.pwa") + ppe.write("output/parameter-summary.srmise") + ppe.writepwa("output/parameter-summary.pwa") # Plot results. # Display plot of extracted peak. It is also possible to plot an existing diff --git a/docs/examples/query_results.py b/docs/examples/query-results.py similarity index 96% rename from docs/examples/query_results.py rename to docs/examples/query-results.py index 1659047..b11ddf9 100644 --- a/docs/examples/query_results.py +++ b/docs/examples/query-results.py @@ -20,10 +20,10 @@ to evaluate the model on an arbitrary grid. The peaks extracted by this script are equivalent to those obtained running -srmise data/Ag_nyquist_qmax30.gr --range 2. 10. \ - --bsrmise output/extract_single_peak.srmise \ - --save output/query_results.srmise \ - --pwa output/query_results.pwa --plot +srmise data/Ag-nyquist-qmax30.gr --range 2. 10. \ + --bsrmise output/extract-single-peak.srmise \ + --save output/query-results.srmise \ + --pwa output/query-results.pwa --plot at the command line. """ @@ -41,13 +41,13 @@ def run(plot=True): ppe = PDFPeakExtraction() # Load the PDF from a file - ppe.loadpdf("data/Ag_nyquist_qmax30.gr") + ppe.loadpdf("data/Ag-nyquist-qmax30.gr") # Obtain baseline from a saved diffpy.srmise trial. This is not the # initial baseline estimate from the previous example, but the baseline # after both it and the extracted peaks have been fit to the data. ppebl = PDFPeakExtraction() - ppebl.read("output/extract_single_peak.srmise") + ppebl.read("output/extract-single-peak.srmise") baseline = ppebl.extracted.baseline # Set up extraction parameters. @@ -196,8 +196,8 @@ def run(plot=True): print("%i: %f" % (total_ideal_intensity, total_observed_intensity)) # Save output - ppe.write("output/query_results.srmise") - ppe.writepwa("output/query_results.pwa") + ppe.write("output/query-results.srmise") + ppe.writepwa("output/query-results.pwa") # Evaluating a model. # Although the ModelCovariance object is useful, the model used for fitting diff --git a/docs/source/tutorial/abbreviations.txt b/docs/source/tutorial/abbreviations.txt index 89c9401..407f586 100644 --- a/docs/source/tutorial/abbreviations.txt +++ b/docs/source/tutorial/abbreviations.txt @@ -10,18 +10,18 @@ .. |tar.gz| replace:: :source-release:`tar.gz` .. Image substitutions -.. |images/extract_single_peak1.png| image:: ../../examples/images/extract_single_peak1.png -.. |images/extract_single_peak2.png| image:: ../../examples/images/extract_single_peak2.png -.. |images/extract_single_peak3.png| image:: ../../examples/images/extract_single_peak3.png -.. |images/parameter_summary1.png| image:: ../../examples/images/parameter_summary1.png -.. |images/parameter_summary2.png| image:: ../../examples/images/parameter_summary2.png -.. |images/parameter_summary3.png| image:: ../../examples/images/parameter_summary3.png -.. |images/parameter_summary4.png| image:: ../../examples/images/parameter_summary4.png -.. |images/fit_initial1.png| image:: ../../examples/images/fit_initial1.png -.. |images/fit_initial2.png| image:: ../../examples/images/fit_initial2.png -.. |images/query_results1.png| image:: ../../examples/images/query_results1.png -.. |images/query_results2.png| image:: ../../examples/images/query_results2.png -.. |images/query_results3.png| image:: ../../examples/images/query_results3.png +.. |images/extract_single_peak1.png| image:: ../../examples/images/extract-single-peak1.png +.. |images/extract_single_peak2.png| image:: ../../examples/images/extract-single-peak2.png +.. |images/extract_single_peak3.png| image:: ../../examples/images/extract-single-peak3.png +.. |images/parameter_summary1.png| image:: ../../examples/images/parameter-summary1.png +.. |images/parameter_summary2.png| image:: ../../examples/images/parameter-summary2.png +.. |images/parameter_summary3.png| image:: ../../examples/images/parameter-summary3.png +.. |images/parameter_summary4.png| image:: ../../examples/images/parameter-summary4.png +.. |images/fit_initial1.png| image:: ../../examples/images/fit-initial1.png +.. |images/fit_initial2.png| image:: ../../examples/images/fit-initial2.png +.. |images/query_results1.png| image:: ../../examples/images/query-results1.png +.. |images/query_results2.png| image:: ../../examples/images/query-results2.png +.. |images/query_results3.png| image:: ../../examples/images/query-results3.png .. External links .. _ParSCAPE algorithm: https://dx.doi.org/10.1107/S2053273315005276 @@ -38,5 +38,5 @@ .. |d_c| replace:: d\ :sub:`c` .. |pi/Qmax| replace:: π/Q\ :sub:`max` -.. Links to PDF information defined in sample_links.txt +.. Links to PDF information defined in sample-links.txt .. |Extending SrMise| replace:: :ref:`extending-srmise` diff --git a/docs/source/tutorial/extract_single_peak.rst b/docs/source/tutorial/extract-single-peak.rst similarity index 71% rename from docs/source/tutorial/extract_single_peak.rst rename to docs/source/tutorial/extract-single-peak.rst index cd3d459..855fb8d 100644 --- a/docs/source/tutorial/extract_single_peak.rst +++ b/docs/source/tutorial/extract-single-peak.rst @@ -1,6 +1,6 @@ .. include:: abbreviations.txt -.. include:: sample_links.txt +.. include:: sample-links.txt .. include:: ../../examples/README.rst @@ -13,4 +13,4 @@ Script (extract_single_peak.py) ------------------------------- -.. literalinclude:: ../../examples/extract_single_peak.py +.. literalinclude:: ../../examples/extract-single-peak.py diff --git a/docs/source/tutorial/fit_initial.rst b/docs/source/tutorial/fit-initial.rst similarity index 72% rename from docs/source/tutorial/fit_initial.rst rename to docs/source/tutorial/fit-initial.rst index 5b95906..3381f3c 100644 --- a/docs/source/tutorial/fit_initial.rst +++ b/docs/source/tutorial/fit-initial.rst @@ -1,6 +1,6 @@ .. include:: abbreviations.txt -.. include:: sample_links.txt +.. include:: sample-links.txt .. include:: ../../examples/README.rst @@ -13,4 +13,4 @@ Script (fit_initial.py) --------------------------- -.. literalinclude:: ../../examples/fit_initial.py +.. literalinclude:: ../../examples/fit-initial.py diff --git a/docs/source/tutorial/index.rst b/docs/source/tutorial/index.rst index 78ea9c1..1131e63 100644 --- a/docs/source/tutorial/index.rst +++ b/docs/source/tutorial/index.rst @@ -15,12 +15,12 @@ Tutorial .. toctree:: :maxdepth: 1 - extract_single_peak - parameter_summary - fit_initial - query_results - multimodel_known_uncertainties - multimodel_unknown_uncertainties + extract-single-peak + parameter-summary + fit-initial + query-results + multimodel-known-uncertainties + multimodel-unknown-uncertainties .. Now add information about the samples diff --git a/docs/source/tutorial/multimodel-known-uncertainties.rst b/docs/source/tutorial/multimodel-known-uncertainties.rst new file mode 100644 index 0000000..e600e6e --- /dev/null +++ b/docs/source/tutorial/multimodel-known-uncertainties.rst @@ -0,0 +1,25 @@ +.. include:: abbreviations.txt + +.. include:: sample-links.txt + + +.. include:: ../../examples/README.rst + :start-after: ~Example 5~ + :end-before: ~Example 6~ + + + +.. _multimodel-known-dG1.py: + +Extraction Script (multimodel-known-dG1.py) +--------------------------------------------- + +.. literalinclude:: ../../examples/multimodel-known-dG1.py + + +.. _multimodel-known-dG2.py: + +Analysis Script (multimodel-known-dG2.py) +----------------------------------------- + +.. literalinclude:: ../../examples/multimodel-known-dG2.py diff --git a/docs/source/tutorial/multimodel-unknown-uncertainties.rst b/docs/source/tutorial/multimodel-unknown-uncertainties.rst new file mode 100644 index 0000000..3c2a13a --- /dev/null +++ b/docs/source/tutorial/multimodel-unknown-uncertainties.rst @@ -0,0 +1,25 @@ +.. include:: abbreviations.txt + +.. include:: sample_links.txt + + +.. include:: ../../examples/README.rst + :start-after: ~Example 6~ + :end-before: ~PDF Info~ + + + +.. _multimodel-unknown-dG1.py: + +Extraction Script (multimodel-unknown-dG1.py) +--------------------------------------------- + +.. literalinclude:: ../../examples/multimodel-unknown-dG1.py + + +.. _multimodel-unknown-dG2.py: + +Analysis Script (multimodel-unknown-dG2.py) +------------------------------------------- + +.. literalinclude:: ../../examples/multimodel-unknown-dG2.py diff --git a/docs/source/tutorial/multimodel_known_uncertainties.rst b/docs/source/tutorial/multimodel_known_uncertainties.rst deleted file mode 100644 index 665bf60..0000000 --- a/docs/source/tutorial/multimodel_known_uncertainties.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. include:: abbreviations.txt - -.. include:: sample_links.txt - - -.. include:: ../../examples/README.rst - :start-after: ~Example 5~ - :end-before: ~Example 6~ - - - -.. _multimodel_known_dG1.py: - -Extraction Script (multimodel_known_dG1.py) ---------------------------------------------- - -.. literalinclude:: ../../examples/multimodel_known_dG1.py - - -.. _multimodel_known_dG2.py: - -Analysis Script (multimodel_known_dG2.py) ------------------------------------------ - -.. literalinclude:: ../../examples/multimodel_known_dG2.py diff --git a/docs/source/tutorial/multimodel_unknown_uncertainties.rst b/docs/source/tutorial/multimodel_unknown_uncertainties.rst deleted file mode 100644 index 11f346c..0000000 --- a/docs/source/tutorial/multimodel_unknown_uncertainties.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. include:: abbreviations.txt - -.. include:: sample_links.txt - - -.. include:: ../../examples/README.rst - :start-after: ~Example 6~ - :end-before: ~PDF Info~ - - - -.. _multimodel_unknown_dG1.py: - -Extraction Script (multimodel_unknown_dG1.py) ---------------------------------------------- - -.. literalinclude:: ../../examples/multimodel_unknown_dG1.py - - -.. _multimodel_unknown_dG2.py: - -Analysis Script (multimodel_unknown_dG2.py) -------------------------------------------- - -.. literalinclude:: ../../examples/multimodel_unknown_dG2.py diff --git a/docs/source/tutorial/parameter_summary.rst b/docs/source/tutorial/parameter-summary.rst similarity index 53% rename from docs/source/tutorial/parameter_summary.rst rename to docs/source/tutorial/parameter-summary.rst index b67a1d4..2ee2313 100644 --- a/docs/source/tutorial/parameter_summary.rst +++ b/docs/source/tutorial/parameter-summary.rst @@ -1,6 +1,6 @@ .. include:: abbreviations.txt -.. include:: sample_links.txt +.. include:: sample-links.txt .. include:: ../../examples/README.rst @@ -8,9 +8,9 @@ :end-before: ~Example 3~ -.. _parameter_summary.py: +.. _parameter-summary.py: -Script (parameter_summary.py) +Script (parameter-summary.py) ----------------------------- -.. literalinclude:: ../../examples/parameter_summary.py +.. literalinclude:: ../../examples/parameter-summary.py diff --git a/docs/source/tutorial/query_results.rst b/docs/source/tutorial/query-results.rst similarity index 64% rename from docs/source/tutorial/query_results.rst rename to docs/source/tutorial/query-results.rst index 324c0a8..fca98d7 100644 --- a/docs/source/tutorial/query_results.rst +++ b/docs/source/tutorial/query-results.rst @@ -1,6 +1,6 @@ .. include:: abbreviations.txt -.. include:: sample_links.txt +.. include:: sample-links.txt .. include:: ../../examples/README.rst @@ -8,9 +8,9 @@ :end-before: ~Example 5~ -.. _query_results.py: +.. _query-results.py: Script (query_results.py) ------------------------- -.. literalinclude:: ../../examples/query_results.py +.. literalinclude:: ../../examples/query-results.py diff --git a/docs/source/tutorial/sample_links.txt b/docs/source/tutorial/sample-links.txt similarity index 100% rename from docs/source/tutorial/sample_links.txt rename to docs/source/tutorial/sample-links.txt diff --git a/news/naming-convention.rst b/news/naming-convention.rst new file mode 100644 index 0000000..d9b08bf --- /dev/null +++ b/news/naming-convention.rst @@ -0,0 +1,23 @@ +**Added:** + +* No News Added: rename docs files with dash connected + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*