Refines documentation and updates tutorial references

Author: AndrewSazonov

docs/index.md

@@ -13,9 +13,8 @@ Here is a brief overview of the main documentation sections:
 - [:material-book-open-variant: User Guide](usage/index.md) - Covers core
   concepts, key terminology, workflow steps, and essential parameters for
   effective use of EasyDiffraction.
-- [:material-school: Hands-on Tutorials](tutorials/index.md) - Offers
-  practical, step-by-step examples demonstrating common workflows and data
-  analysis tasks.
+- [:material-school: Tutorials](tutorials/index.md) - Offers practical,
+  step-by-step examples demonstrating common workflows and data analysis tasks.
 - [:material-code-braces-box: API Reference](api/index.md) - An auto-generated
   reference detailing the available functions and modules in EasyDiffraction.
 - [:material-account-plus: Contributing](contributing/index.md) - Outlines

docs/installation/index.md

@@ -7,7 +7,7 @@ icon: material/cog-box
 ## Requirements
 
 EasyDiffraction is a multi-platform Python library compatible with **Python
-3.9 through 3.12**. Ensure Python is installed
+3.10 through 3.12**. Ensure that Python is installed
 on your system before proceeding with the installation.
 
 ## Environment setup <small>optional</small> { #environment-setup data-toc-label="Environment setup" }
@@ -35,9 +35,9 @@ recreate the environment.
         ```
     === ":fontawesome-brands-windows: Windows"
         ```console
-        . venv/Scripts/activate      # Windows with Unix like shells
+        . venv/Scripts/activate      # Windows with Unix-like shells
         .\venv\Scripts\activate.bat  # Windows with CMD
-        .\venv\Scripts\activate.ps1  # Windows with Power shell
+        .\venv\Scripts\activate.ps1  # Windows with PowerShell
         ```
 <!-- prettier-ignore-end -->
 - The terminal should now show `(venv)`, indicating that the virtual
@@ -91,7 +91,7 @@ with:
 pip install easydiffraction
 ```
 
-To install a specific version of EasyDiffraction, e.g. 1.0.3:
+To install a specific version of EasyDiffraction, e.g., 1.0.3:
 
 ```console
 pip install 'easydiffraction==1.0.3'
@@ -117,36 +117,41 @@ for testing purposes.
 To install EasyDiffraction from, e.g., the `develop` branch of GitHub:
 
 ```console
-pip install git+https://github.com/easyscience/EasyDiffractionLib@develop
+pip install git+https://github.com/easyscience/diffraction-lib@develop
 ```
 
 To include extra dependencies (e.g., charts):
 
 ```console
-pip install 'easydiffraction[charts] @ git+https://github.com/easyscience/EasyDiffractionLib@develop'
+pip install 'easydiffraction[charts] @ git+https://github.com/easyscience/diffraction-lib@develop'
 ```
 
 ## Running tutorials
 
 EasyDiffraction provides a collection of **Jupyter Notebook examples** that
-demonstrate various functionalities. These tutorials are available in the
-[:material-school: Hands-on tutorials](../tutorials/index.md) section of the
-documentation.
+demonstrate various functionalities. These tutorials serve as
+**step-by-step guides**, helping users understand the workflow of diffraction
+data analysis in EasyDiffraction. They are available in the
+[:material-school: Tutorials](../tutorials/index.md) section of the
+documentation as **static HTML pages** for easy reference. However, you can
+also run them interactively in two ways:
 
-You can also run these tutorials:
+- **Run Locally** – Download the Jupyter Notebook file using the
+  :material-download: **Download** button and execute it on your computer.
+- **Run Online** – Open it with the :google-colab: **Open in Google Colab**
+  button and execute the tutorial directly in **Google Colab**, without
+  requiring any local setup.
 
-- **Locally on your machine**
-- **Online via Google Colab** (no local installation required)
+!!! note
 
-These Jupyter Notebook examples can be downloaded either one by one from the
-[:material-school: Hands-on tutorials](../tutorials/index.md) section or all
-together as a zip archive from the
-[EasyDiffraction releases](https://github.com/easyscience/EasyDiffractionLib/releases/latest).
+    These Jupyter notebooks can also be downloaded all at once as a zip archive
+    from the
+    [EasyDiffraction releases](https://github.com/easyscience/diffraction-lib/releases/latest).
 
 ### Run tutorials locally
 
 To run tutorials locally, install Jupyter Notebook or JupyterLab.
-Here are the steps to take in the case of Jupyter Notebook:
+Here are the steps to follow in the case of Jupyter Notebook:
 
 - Install Jupyter Notebook:
   ```console
@@ -155,13 +160,13 @@ Here are the steps to take in the case of Jupyter Notebook:
 - Download the latest EasyDiffraction tutorial examples from GitHub, e.g.,
   using curl:
   ```console
-  curl --location --remote-name https://github.com/easyscience/EasyDiffractionLib/releases/latest/download/examples.zip
+  curl --location --remote-name https://github.com/easyscience/{{project__repos__lib}}/releases/latest/download/examples.zip
   ```
 - Unzip the archive:
   ```console
   unzip examples.zip
   ```
-- Run Jupyter Notebook server in the `examples/` directory:
+- Run the Jupyter Notebook server in the `examples/` directory:
   ```console
   jupyter notebook examples/
   ```
@@ -180,7 +185,7 @@ To use Google Colab:
 
 - Ensure you have a **Google account**.
 - Navigate to the
-  **[:material-school: Hands-on tutorials](../tutorials/index.md)** section of
+  **[:material-school: Tutorials](../tutorials/index.md)** section of
   the documentation.
 - Click the :google-colab: **Open in Google Colab** button available for each
   tutorial.

docs/mkdocs.yml

@@ -54,18 +54,18 @@ nav:
         - Analysis: usage/workflow-steps/analysis.md
         - Summary: usage/workflow-steps/summary.md
   - Tutorials:
-      - Tutorials: tutorials/index.md
-      - Basic Usage:
-          - SingleFit pd-neut-cwl: tutorials/basic_single-fit_pd-neut-cwl_LBCO-HRPT.ipynb
-      - Advanced Usage:
-          - SingleFit pd-neut-tof 1: tutorials/advanced_single-fit_pd-neut-tof_Si-SEPD.ipynb
-          - SingleFit pd-neut-tof 2: tutorials/advanced_single-fit_pd-neut-tof_NCAF-WISH.ipynb
-          - SingleFit pd-neut-cwl: tutorials/advanced_single-fit_pd-neut-cwl_HS-HRPT.ipynb
-          - JointFit pd-neut-xray-cwl: tutorials/advanced_joint-fit_pd-neut-xray-cwl_PbSO4.ipynb
+      - Getting Started: tutorials/index.md
+      - Basic vs. Advanced:
+          - LBCO pd-neut-cwl: tutorials/basic_single-fit_pd-neut-cwl_LBCO-HRPT.ipynb
+          - PbSO4 pd-neut-xray-cwl: tutorials/advanced_joint-fit_pd-neut-xray-cwl_PbSO4.ipynb
+      - Structure Refinement:
+          - HS pd-neut-cwl: tutorials/cryst-struct_pd-neut-cwl_HS-HRPT.ipynb
+          - Si pd-neut-tof: tutorials/cryst-struct_pd-neut-tof_Si-SEPD.ipynb
+          - NCAF pd-neut-tof: tutorials/cryst-struct_pd-neut-tof_NCAF-WISH.ipynb
       - Pair Distribution Function:
-          - SingleFit pd-neut-tof: tutorials/pdf_pd-neut-tof_Si-NOMAD.ipynb
-          - SingleFit pd-neut-cwl: tutorials/pdf_pd-neut-cwl_Ni.ipynb
-          - SingleFit pd-xray: tutorials/pdf_pd-xray_NaCl.ipynb
+          - Ni pd-neut-cwl: tutorials/pdf_pd-neut-cwl_Ni.ipynb
+          - Si pd-neut-tof: tutorials/pdf_pd-neut-tof_Si-NOMAD.ipynb
+          - NaCl pd-xray: tutorials/pdf_pd-xray_NaCl.ipynb
   - API Reference:
       - API Reference: api/index.md
       - api/core.md

docs/tutorials/index.md

@@ -4,30 +4,50 @@ icon: material/school
 
 # :material-school: Tutorials
 
-This section provides a collection of **Jupyter Notebook examples** that
-demonstrate how to use EasyDiffraction for various tasks. These tutorials
-serve as **step-by-step guides**, helping users understand the workflow of
-diffraction data analysis in EasyDiffraction.
-
-## Running tutorials
-
-In this documentation, the examples are presented as **static HTML pages** for
-easy reference. However, you can also run them interactively in two ways:
-
-- **Run Locally** – Download the Jupyter Notebook file and execute it on your
-  computer.
-- **Run Online** – Open and execute the tutorial directly in **Google Colab**,
-  without requiring any local setup.
-
-## Interactive features
-
-At the **top right corner** of each tutorial page, you will find:
-
-- A **download button** :material-download: to save the example as a
-  Jupyter Notebook (`.ipynb`) file.
-- A **Google Colab button** :google-colab: to open and run the tutorial
-  in Google Colab, allowing you to experiment with EasyDiffraction
-  directly in your browser.
-
-By using these interactive options, you can test, modify, and explore
-EasyDiffraction's capabilities in a hands-on manner.
+This section offers a collection of **Jupyter Notebook examples** illustrating
+the usage of EasyDiffraction for various tasks. These tutorials act as
+**step-by-step guides**, helping users grasp the workflow of diffraction data
+analysis within EasyDiffraction.
+
+An instruction on how to run the tutorials is provided in the
+[:material-cog-box: Installation & Setup](../installation/index.md#running-tutorials)
+section of the documentation.
+
+The tutorials are categorized as follows.
+
+## Basic vs. Advanced
+
+- [LBCO `pd-neut-cwl`](basic_single-fit_pd-neut-cwl_LBCO-HRPT.ipynb) -
+  Demonstrates usage of the EasyDiffraction API in a simplified,
+  user-friendly manner that closely follows the GUI workflow for a Rietveld
+  refinement of La0.5Ba0.5CoO3 crystal structure using constant wavelength
+  neutron powder diffraction data from HRPT at PSI.
+- [PbSO4 `pd-neut-xray-cwl`](advanced_joint-fit_pd-neut-xray-cwl_PbSO4.ipynb) -
+  Demonstrates a more flexible and advanced approach to use the
+  EasyDiffraction library, intended for users more comfortable with Python
+  programming. This tutorial covers a Rietveld refinement of PbSO4 crystal
+  structure based on the joint fit of both X-ray and neutron diffraction data.
+
+## Standard Diffraction
+
+- [HS `pd-neut-cwl`](cryst-struct_pd-neut-cwl_HS-HRPT.ipynb) -
+  Demonstrates a Rietveld refinement of HS crystal structure using constant
+  wavelength neutron powder diffraction data from HRPT at PSI.
+- [Si `pd-neut-tof`](cryst-struct_pd-neut-tof_Si-SEPD.ipynb) -
+  Demonstrates a Rietveld refinement of Si crystal structure using
+  time-of-flight neutron powder diffraction data from SEPD at Argonne.
+- [NCAF `pd-neut-tof`](cryst-struct_pd-neut-tof_NCAF-WISH.ipynb) -
+  Demonstrates a Rietveld refinement of Na2Ca3Al2F14 crystal structure using
+  time-of-flight neutron powder diffraction data from WISH at ISIS.
+
+## Pair Distribution Function (PDF)
+
+- [Ni `pd-neut-cwl`](pdf_pd-neut-cwl_Ni.ipynb) -
+  Demonstrates a PDF analysis of Ni based on data collected from a constant
+  wavelength neutron powder diffraction experiment.
+- [Si `pd-neut-tof`](pdf_pd-neut-tof_Si-NOMAD.ipynb) -
+  Demonstrates a PDF analysis of Si based on data collected from a
+  time-of-flight neutron powder diffraction experiment at NOMAD at SNS.
+- [NaCl `pd-xray`](pdf_pd-xray_NaCl.ipynb) -
+  Demonstrates a PDF analysis of NaCl based on data collected from an X-ray
+  powder diffraction experiment.