Datasets:

caobin
/

PyXplore

Modalities:

Image

Formats:

imagefolder

Size:

< 1K

DOI:

Libraries:

Datasets

License:

Dataset card Data Studio Files Files and versions Community

PyXplore

File size: 43,643 Bytes

56c956f


<!DOCTYPE html>


<html lang="en" data-content_root="./" >

  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

    <title>Parameters and Functions Documentation &#8212; PyXplore Book</title>
  
  
  
  <script data-cfasync="false">
    document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
    document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
  </script>
  
  <!-- Loaded before other Sphinx assets -->
  <link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />

  
  <link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
  <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />

    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b76e3c8a" />
    <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
    <link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <link rel="stylesheet" type="text/css" href="_static/mystnb.8ecb98da25f57f5357bf6f572d296f466b2cfe2517ffebfabe82451661e28f02.css" />
    <link rel="stylesheet" type="text/css" href="_static/sphinx-thebe.css?v=4fa983c6" />
    <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
  
  <!-- Pre-loaded scripts that we'll load fully later -->
  <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
  <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>

    <script src="_static/documentation_options.js?v=9eb32ce0"></script>
    <script src="_static/doctools.js?v=888ff710"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=f281be69"></script>
    <script src="_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
    <script>let toggleHintShow = 'Click to show';</script>
    <script>let toggleHintHide = 'Click to hide';</script>
    <script>let toggleOpenOnPrint = 'true';</script>
    <script src="_static/togglebutton.js?v=4a39c7ea"></script>
    <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
    <script src="_static/design-tabs.js?v=f930bc37"></script>
    <script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
    <script async="async" src="_static/sphinx-thebe.js?v=c100c467"></script>
    <script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
    <script>const THEBE_JS_URL = "https://unpkg.com/thebe@0.8.2/lib/index.js"; const thebe_selector = ".thebe,.cell"; const thebe_selector_input = "pre"; const thebe_selector_output = ".output, .cell_output"</script>
    <script>DOCUMENTATION_OPTIONS.pagename = 'parameter';</script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Results Files Documentation" href="resultsFiles.html" />
    <link rel="prev" title="Welcome to PyXplore" href="intro.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <meta name="docsearch:language" content="en"/>
  </head>
  
  
  <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">

  
  
  <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
  
  <div id="pst-scroll-pixel-helper"></div>
  
  <button type="button" class="btn rounded-pill" id="pst-back-to-top">
    <i class="fa-solid fa-arrow-up"></i>Back to top</button>

  
  <input type="checkbox"
          class="sidebar-toggle"
          id="pst-primary-sidebar-checkbox"/>
  <label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
  
  <input type="checkbox"
          class="sidebar-toggle"
          id="pst-secondary-sidebar-checkbox"/>
  <label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
  
  <div class="search-button__wrapper">
    <div class="search-button__overlay"></div>
    <div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
      action="search.html"
      method="get">
  <i class="fa-solid fa-magnifying-glass"></i>
  <input type="search"
         class="form-control"
         name="q"
         id="search-input"
         placeholder="Search this book..."
         aria-label="Search this book..."
         autocomplete="off"
         autocorrect="off"
         autocapitalize="off"
         spellcheck="false"/>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
  </div>

  <div class="pst-async-banner-revealer d-none">
  <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>

  
    <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
    </header>
  

  <div class="bd-container">
    <div class="bd-container__inner bd-page-width">
      
      
      
      <div class="bd-sidebar-primary bd-sidebar">
        

  
  <div class="sidebar-header-items sidebar-primary__section">
    
    
    
    
  </div>
  
    <div class="sidebar-primary-items__start sidebar-primary__section">
        <div class="sidebar-primary-item">

  
    
  

<a class="navbar-brand logo" href="intro.html">
  
  
  
  
  
    
    
      
    
    
    <img src="_static/logo.png" class="logo__image only-light" alt="PyXplore Book - Home"/>
    <script>document.write(`<img src="_static/logo.png" class="logo__image only-dark" alt="PyXplore Book - Home"/>`);</script>
  
  
</a></div>
        <div class="sidebar-primary-item">

 <script>
 document.write(`
   <button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="fa-solid fa-magnifying-glass"></i>
    <span class="search-button__default-text">Search</span>
    <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
   </button>
 `);
 </script></div>
        <div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
    <div class="bd-toc-item navbar-nav active">
        
        <ul class="nav bd-sidenav bd-sidenav__home-link">
            <li class="toctree-l1">
                <a class="reference internal" href="intro.html">
                    Welcome to PyXplore
                </a>
            </li>
        </ul>
        <ul class="current nav bd-sidenav">
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Parameters and Functions Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="resultsFiles.html">Results Files Documentation</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="tutorials/index.html">Tutorial Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials/basic_opt/1st.html">The tutorial 1st</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/multi_phases/2nd.html">The tutorial 2nd</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/amorphous/3rd.html">The tutorial 3rd</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/simulation/4th.html">The tutorial 4th</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/atomic_dis/5th.html">The tutorial 5th</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/solid_solution/6th.html">The tutorial 6th</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/EXAFS/7th.html">The tutorial 7th</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials/XPS/8th.html">The tutorial 8th</a></li>
</ul><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary>
</details></li>
</ul>

    </div>
</nav></div>
    </div>
  
  
  <div class="sidebar-primary-items__end sidebar-primary__section">
  </div>
  
  <div id="rtd-footer-container"></div>


      </div>
      
      <main id="main-content" class="bd-main" role="main">
        
        

<div class="sbt-scroll-pixel-helper"></div>

          <div class="bd-content">
            <div class="bd-article-container">
              
              <div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
  
    <div class="header-article-items__start">
      
        <div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
  <span class="fa-solid fa-bars"></span>
</button></div>
      
    </div>
  
  
    <div class="header-article-items__end">
      
        <div class="header-article-item">

<div class="article-header-buttons">





<div class="dropdown dropdown-source-buttons">
  <button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Source repositories">
    <i class="fab fa-github"></i>
  </button>
  <ul class="dropdown-menu">
      
      
      
      <li><a href="https://github.com/Bin-Cao/PyWPEM" target="_blank"
   class="btn btn-sm btn-source-repository-button dropdown-item"
   title="Source repository"
   data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fab fa-github"></i>
  </span>
<span class="btn__text-container">Repository</span>
</a>
</li>
      
      
      
      
      <li><a href="https://github.com/Bin-Cao/PyWPEM/issues/new?title=Issue%20on%20page%20%2Fparameter.html&body=Your%20issue%20content%20here." target="_blank"
   class="btn btn-sm btn-source-issues-button dropdown-item"
   title="Open an issue"
   data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-lightbulb"></i>
  </span>
<span class="btn__text-container">Open issue</span>
</a>
</li>
      
  </ul>
</div>






<div class="dropdown dropdown-download-buttons">
  <button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
    <i class="fas fa-download"></i>
  </button>
  <ul class="dropdown-menu">
      
      
      
      <li><a href="_sources/parameter.md" target="_blank"
   class="btn btn-sm btn-download-source-button dropdown-item"
   title="Download source file"
   data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-file"></i>
  </span>
<span class="btn__text-container">.md</span>
</a>
</li>
      
      
      
      
      <li>
<button onclick="window.print()"
  class="btn btn-sm btn-download-pdf-button dropdown-item"
  title="Print to PDF"
  data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-file-pdf"></i>
  </span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
      
  </ul>
</div>




<button onclick="toggleFullScreen()"
  class="btn btn-sm btn-fullscreen-button"
  title="Fullscreen mode"
  data-bs-placement="bottom" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-expand"></i>
  </span>

</button>



<script>
document.write(`
  <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
    <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
    <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
  </button>
`);
</script>


<script>
document.write(`
  <button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="fa-solid fa-magnifying-glass fa-lg"></i>
  </button>
`);
</script>
<button class="sidebar-toggle secondary-toggle btn btn-sm" title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <span class="fa-solid fa-list"></span>
</button>
</div></div>
      
    </div>
  
</div>
</div>
              
              

<div id="jb-print-docs-body" class="onlyprint">
    <h1>Parameters and Functions Documentation</h1>
    <!-- Table of contents -->
    <div id="print-main-content">
        <div id="jb-print-toc">
            
            <div>
                <h2> Contents </h2>
            </div>
            <nav aria-label="Page">
                <ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-wpem">Module: WPEM</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#author">Author</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#functions-overview">Functions Overview</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#wpemsolver">1. <code class="docutils literal notranslate"><span class="pre">WPEMsolver</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#twicefilter-convert-file-read-xrdml">2. <code class="docutils literal notranslate"><span class="pre">TwiceFilter</span></code>, <code class="docutils literal notranslate"><span class="pre">convert_file</span></code>, <code class="docutils literal notranslate"><span class="pre">read_xrdml</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#amorphous-fitting">3. <code class="docutils literal notranslate"><span class="pre">Amorphous_fitting</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#radialdistribution">4. <code class="docutils literal notranslate"><span class="pre">RadialDistribution</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#decomposedpeaks">5. <code class="docutils literal notranslate"><span class="pre">Decomposedpeaks</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#xrd-profile">6. <code class="docutils literal notranslate"><span class="pre">XRD_profile</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#profile">7. <code class="docutils literal notranslate"><span class="pre">profile</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#bgolearnopt">8. <code class="docutils literal notranslate"><span class="pre">BgolearnOpt</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#xpssolver">9. <code class="docutils literal notranslate"><span class="pre">XPSsolver</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#exafs">10. <code class="docutils literal notranslate"><span class="pre">EXAFS</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#crystalgraph">11. <code class="docutils literal notranslate"><span class="pre">CrystalGraph</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#executable-information">Executable Information</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#execution-information">Execution Information</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#key-functions">Key Functions</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#xrdfit"><code class="docutils literal notranslate"><span class="pre">XRDfit</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#parameters">Parameters:</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#returns">Returns:</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#backgroundfit"><code class="docutils literal notranslate"><span class="pre">BackgroundFit</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">Parameters:</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id2">Returns:</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#filetypecovert"><code class="docutils literal notranslate"><span class="pre">FileTypeCovert</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id3">Parameters:</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id4">Returns:</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#amorphous-fit"><code class="docutils literal notranslate"><span class="pre">Amorphous_fit</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id5">Parameters:</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id6">Returns:</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#crygraph"><code class="docutils literal notranslate"><span class="pre">CryGraph</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id7">Parameters:</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id8">Returns:</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#additional-functions">Additional Functions</a></li>
</ul>
</li>
</ul>
            </nav>
        </div>
    </div>
</div>

              
                
<div id="searchbox"></div>
                <article class="bd-article">
                  
  <section class="tex2jax_ignore mathjax_ignore" id="parameters-and-functions-documentation">
<h1>Parameters and Functions Documentation<a class="headerlink" href="#parameters-and-functions-documentation" title="Link to this heading">#</a></h1>
<section id="module-wpem">
<h2>Module: WPEM<a class="headerlink" href="#module-wpem" title="Link to this heading">#</a></h2>
<p>WPEM is the main call interface for diffraction refinement and analysis software, including various functions and subroutines for XRD analysis, background fitting, amorphous fitting, and more.</p>
<section id="author">
<h3>Author<a class="headerlink" href="#author" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p><strong>Bin CAO</strong><br />
Email: <a class="reference external" href="mailto:bincao4-c&#37;&#52;&#48;my&#46;cityu&#46;edu&#46;hk">bincao4-c<span>&#64;</span>my<span>&#46;</span>cityu<span>&#46;</span>edu<span>&#46;</span>hk</a><br />
GitHub: <a class="github reference external" href="https://github.com/Bin-Cao/PyWPEM">Bin-Cao/PyWPEM</a></p></li>
</ul>
</section>
</section>
<hr class="docutils" />
<section id="functions-overview">
<h2>Functions Overview<a class="headerlink" href="#functions-overview" title="Link to this heading">#</a></h2>
<section id="wpemsolver">
<h3>1. <code class="docutils literal notranslate"><span class="pre">WPEMsolver</span></code><a class="headerlink" href="#wpemsolver" title="Link to this heading">#</a></h3>
<p><strong>From:</strong> <code class="docutils literal notranslate"><span class="pre">EMBraggOpt.EMBraggSolver</span></code><br />
Solver for XRD profile refinement and analysis.</p>
</section>
<section id="twicefilter-convert-file-read-xrdml">
<h3>2. <code class="docutils literal notranslate"><span class="pre">TwiceFilter</span></code>, <code class="docutils literal notranslate"><span class="pre">convert_file</span></code>, <code class="docutils literal notranslate"><span class="pre">read_xrdml</span></code><a class="headerlink" href="#twicefilter-convert-file-read-xrdml" title="Link to this heading">#</a></h3>
<p><strong>From:</strong> <code class="docutils literal notranslate"><span class="pre">Background.BacDeduct</span></code></p>
<ul class="simple">
<li><p><strong><code class="docutils literal notranslate"><span class="pre">TwiceFilter</span></code></strong>: Applies filtering techniques for background adjustments.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">convert_file</span></code></strong>: Converts XRD data files to the required format.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">read_xrdml</span></code></strong>: Reads <code class="docutils literal notranslate"><span class="pre">.xrdml</span></code> files for diffraction data.</p></li>
</ul>
</section>
<section id="amorphous-fitting">
<h3>3. <code class="docutils literal notranslate"><span class="pre">Amorphous_fitting</span></code><a class="headerlink" href="#amorphous-fitting" title="Link to this heading">#</a></h3>
<p><strong>From:</strong> <code class="docutils literal notranslate"><span class="pre">Amorphous.fitting.AmorphousFitting</span></code><br />
Fitting routine for amorphous phase diffraction data.</p>
</section>
<section id="radialdistribution">
<h3>4. <code class="docutils literal notranslate"><span class="pre">RadialDistribution</span></code><a class="headerlink" href="#radialdistribution" title="Link to this heading">#</a></h3>
<p><strong>From:</strong> <code class="docutils literal notranslate"><span class="pre">Amorphous.QuantitativeCalculation.AmorphousRDF</span></code><br />
Calculates the radial distribution function (RDF) for amorphous materials.</p>
</section>
<section id="decomposedpeaks">
<h3>5. <code class="docutils literal notranslate"><span class="pre">Decomposedpeaks</span></code><a class="headerlink" href="#decomposedpeaks" title="Link to this heading">#</a></h3>
<p><strong>From:</strong> <code class="docutils literal notranslate"><span class="pre">DecomposePlot.plot</span></code><br />
Decomposes diffraction peaks for detailed analysis.</p>
</section>
<section id="xrd-profile">
<h3>6. <code class="docutils literal notranslate"><span class="pre">XRD_profile</span></code><a class="headerlink" href="#xrd-profile" title="Link to this heading">#</a></h3>
<p><strong>From:</strong> <code class="docutils literal notranslate"><span class="pre">XRDSimulation.Simulation</span></code><br />
Simulates XRD profiles for given crystal structures.</p>
</section>
<section id="profile">
<h3>7. <code class="docutils literal notranslate"><span class="pre">profile</span></code><a class="headerlink" href="#profile" title="Link to this heading">#</a></h3>
<p><strong>From:</strong> <code class="docutils literal notranslate"><span class="pre">Extinction.XRDpre</span></code><br />
Generates XRD profiles with customizable parameters.</p>
</section>
<section id="bgolearnopt">
<h3>8. <code class="docutils literal notranslate"><span class="pre">BgolearnOpt</span></code><a class="headerlink" href="#bgolearnopt" title="Link to this heading">#</a></h3>
<p><strong>From:</strong> <code class="docutils literal notranslate"><span class="pre">StructureOpt.SiteOpt</span></code><br />
Performs optimization for substitutional search and refinement.</p>
</section>
<section id="xpssolver">
<h3>9. <code class="docutils literal notranslate"><span class="pre">XPSsolver</span></code><a class="headerlink" href="#xpssolver" title="Link to this heading">#</a></h3>
<p><strong>From:</strong> <code class="docutils literal notranslate"><span class="pre">WPEMXPS.XPSEM</span></code><br />
Solver for X-ray Photoelectron Spectroscopy (XPS) data refinement.</p>
</section>
<section id="exafs">
<h3>10. <code class="docutils literal notranslate"><span class="pre">EXAFS</span></code><a class="headerlink" href="#exafs" title="Link to this heading">#</a></h3>
<p><strong>From:</strong> <code class="docutils literal notranslate"><span class="pre">WPEMXAS.EXAFS</span></code><br />
Performs Extended X-ray Absorption Fine Structure (EXAFS) analysis.</p>
</section>
<section id="crystalgraph">
<h3>11. <code class="docutils literal notranslate"><span class="pre">CrystalGraph</span></code><a class="headerlink" href="#crystalgraph" title="Link to this heading">#</a></h3>
<p><strong>From:</strong> <code class="docutils literal notranslate"><span class="pre">GraphStructure.graph</span></code><br />
Generates crystal graphs for structural analysis.</p>
</section>
</section>
<hr class="docutils" />
<section id="executable-information">
<h2>Executable Information<a class="headerlink" href="#executable-information" title="Link to this heading">#</a></h2>
<section id="execution-information">
<h3>Execution Information<a class="headerlink" href="#execution-information" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p><strong>Software Name</strong>: WPEM (Diffraction Refinement Software)</p></li>
<li><p><strong>Author</strong>: Bin Cao, Advanced Materials Thrust, Hong Kong University of Science and Technology (Guangzhou) ｜ Department of physics, City University of Hong Kong</p></li>
<li><p><strong>URL</strong>: <a class="github reference external" href="https://github.com/Bin-Cao/WPEM">Bin-Cao/WPEM</a></p></li>
<li><p><strong>Execution Time</strong>: Dynamically generated at runtime.</p></li>
</ul>
</section>
</section>
<hr class="docutils" />
<section id="key-functions">
<h2>Key Functions<a class="headerlink" href="#key-functions" title="Link to this heading">#</a></h2>
<section id="xrdfit">
<h3><code class="docutils literal notranslate"><span class="pre">XRDfit</span></code><a class="headerlink" href="#xrdfit" title="Link to this heading">#</a></h3>
<section id="parameters">
<h4>Parameters:<a class="headerlink" href="#parameters" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p><strong><code class="docutils literal notranslate"><span class="pre">wavelength</span></code></strong>: List of diffraction wavelengths.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">Var</span></code></strong>: Statistical variance of the background.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">Lattice_constants</span></code></strong>: Initial lattice constants for refinement.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">no_bac_intensity_file</span></code></strong>, <strong><code class="docutils literal notranslate"><span class="pre">original_file</span></code></strong>, <strong><code class="docutils literal notranslate"><span class="pre">bacground_file</span></code></strong>: Input data files.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">two_theta_range</span></code></strong>: Range of diffraction angles to analyze.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">density_list</span></code></strong>: Densities of crystals (optional).</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">MODEL</span></code></strong>: Mode of analysis (<code class="docutils literal notranslate"><span class="pre">'REFINEMENT'</span></code> or <code class="docutils literal notranslate"><span class="pre">'ANALYSIS'</span></code>).</p></li>
</ul>
</section>
<section id="returns">
<h4>Returns:<a class="headerlink" href="#returns" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p>Refined lattice constants, R-factor values, and runtime details.</p></li>
</ul>
</section>
</section>
<hr class="docutils" />
<section id="backgroundfit">
<h3><code class="docutils literal notranslate"><span class="pre">BackgroundFit</span></code><a class="headerlink" href="#backgroundfit" title="Link to this heading">#</a></h3>
<section id="id1">
<h4>Parameters:<a class="headerlink" href="#id1" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p><strong><code class="docutils literal notranslate"><span class="pre">intensity_csv</span></code></strong>: Input XRD data file.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">LFctg</span></code>, <code class="docutils literal notranslate"><span class="pre">lowAngleRange</span></code>, <code class="docutils literal notranslate"><span class="pre">bac_num</span></code>, <code class="docutils literal notranslate"><span class="pre">bac_split</span></code></strong>: Background filter parameters.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">window_length</span></code>, <code class="docutils literal notranslate"><span class="pre">polyorder</span></code>, <code class="docutils literal notranslate"><span class="pre">mode</span></code></strong>: Polynomial fitting settings.</p></li>
</ul>
</section>
<section id="id2">
<h4>Returns:<a class="headerlink" href="#id2" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p>Background distribution statistics.</p></li>
</ul>
</section>
</section>
<hr class="docutils" />
<section id="filetypecovert">
<h3><code class="docutils literal notranslate"><span class="pre">FileTypeCovert</span></code><a class="headerlink" href="#filetypecovert" title="Link to this heading">#</a></h3>
<section id="id3">
<h4>Parameters:<a class="headerlink" href="#id3" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p><strong><code class="docutils literal notranslate"><span class="pre">file_name</span></code></strong>: Source file name.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">file_type</span></code></strong>: Format of the input file (<code class="docutils literal notranslate"><span class="pre">'dat'</span></code> or <code class="docutils literal notranslate"><span class="pre">'xrdml'</span></code>).</p></li>
</ul>
</section>
<section id="id4">
<h4>Returns:<a class="headerlink" href="#id4" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p>Converted data.</p></li>
</ul>
</section>
</section>
<hr class="docutils" />
<section id="amorphous-fit">
<h3><code class="docutils literal notranslate"><span class="pre">Amorphous_fit</span></code><a class="headerlink" href="#amorphous-fit" title="Link to this heading">#</a></h3>
<section id="id5">
<h4>Parameters:<a class="headerlink" href="#id5" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p><strong><code class="docutils literal notranslate"><span class="pre">mix_component</span></code></strong>: Number of amorphous peaks.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">amor_file</span></code></strong>: Amorphous data file.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">ang_range</span></code></strong>: Angle range for refinement.</p></li>
</ul>
</section>
<section id="id6">
<h4>Returns:<a class="headerlink" href="#id6" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p>Amorphous fit results.</p></li>
</ul>
</section>
</section>
<hr class="docutils" />
<section id="crygraph">
<h3><code class="docutils literal notranslate"><span class="pre">CryGraph</span></code><a class="headerlink" href="#crygraph" title="Link to this heading">#</a></h3>
<section id="id7">
<h4>Parameters:<a class="headerlink" href="#id7" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p><strong><code class="docutils literal notranslate"><span class="pre">folder_path</span></code></strong>: Path to save CIF files.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">BK_boundary_condition</span></code></strong>: Whether to apply Bon Kaman boundary conditions.</p></li>
</ul>
</section>
<section id="id8">
<h4>Returns:<a class="headerlink" href="#id8" title="Link to this heading">#</a></h4>
<ul class="simple">
<li><p>Crystal structure graphs.</p></li>
</ul>
</section>
</section>
<hr class="docutils" />
<section id="additional-functions">
<h3>Additional Functions<a class="headerlink" href="#additional-functions" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p><strong><code class="docutils literal notranslate"><span class="pre">AmorphousRDFun</span></code></strong>: Computes radial distribution function for amorphous phases.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">Plot_Components</span></code></strong>: Visualizes decomposed XRD components.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">XRDSimulation</span></code></strong>: Simulates XRD patterns for given CIF files.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">CIFpreprocess</span></code></strong>: Processes CIF files for XRD analysis.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">SubstitutionalSearch</span></code></strong>: Conducts substitutional optimization searches.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">XPSfit</span></code></strong>: Fits XPS data for electron binding energy analysis.</p></li>
<li><p><strong><code class="docutils literal notranslate"><span class="pre">EXAFSfit</span></code></strong>: Performs EXAFS analysis for structural and bonding studies.</p></li>
</ul>
</section>
</section>
</section>

    <script type="text/x-thebe-config">
    {
        requestKernel: true,
        binderOptions: {
            repo: "binder-examples/jupyter-stacks-datascience",
            ref: "master",
        },
        codeMirrorConfig: {
            theme: "abcdef",
            mode: "python"
        },
        kernelOptions: {
            name: "python3",
            path: "./."
        },
        predefinedOutput: true
    }
    </script>
    <script>kernelName = 'python3'</script>

                </article>
              

              
              
              
              
                <footer class="prev-next-footer d-print-none">
                  
<div class="prev-next-area">
    <a class="left-prev"
       href="intro.html"
       title="previous page">
      <i class="fa-solid fa-angle-left"></i>
      <div class="prev-next-info">
        <p class="prev-next-subtitle">previous</p>
        <p class="prev-next-title">Welcome to PyXplore</p>
      </div>
    </a>
    <a class="right-next"
       href="resultsFiles.html"
       title="next page">
      <div class="prev-next-info">
        <p class="prev-next-subtitle">next</p>
        <p class="prev-next-title">Results Files Documentation</p>
      </div>
      <i class="fa-solid fa-angle-right"></i>
    </a>
</div>
                </footer>
              
            </div>
            
            
              
                <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


  <div class="sidebar-secondary-item">
  <div class="page-toc tocsection onthispage">
    <i class="fa-solid fa-list"></i> Contents
  </div>
  <nav class="bd-toc-nav page-toc">
    <ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-wpem">Module: WPEM</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#author">Author</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#functions-overview">Functions Overview</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#wpemsolver">1. <code class="docutils literal notranslate"><span class="pre">WPEMsolver</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#twicefilter-convert-file-read-xrdml">2. <code class="docutils literal notranslate"><span class="pre">TwiceFilter</span></code>, <code class="docutils literal notranslate"><span class="pre">convert_file</span></code>, <code class="docutils literal notranslate"><span class="pre">read_xrdml</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#amorphous-fitting">3. <code class="docutils literal notranslate"><span class="pre">Amorphous_fitting</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#radialdistribution">4. <code class="docutils literal notranslate"><span class="pre">RadialDistribution</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#decomposedpeaks">5. <code class="docutils literal notranslate"><span class="pre">Decomposedpeaks</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#xrd-profile">6. <code class="docutils literal notranslate"><span class="pre">XRD_profile</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#profile">7. <code class="docutils literal notranslate"><span class="pre">profile</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#bgolearnopt">8. <code class="docutils literal notranslate"><span class="pre">BgolearnOpt</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#xpssolver">9. <code class="docutils literal notranslate"><span class="pre">XPSsolver</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#exafs">10. <code class="docutils literal notranslate"><span class="pre">EXAFS</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#crystalgraph">11. <code class="docutils literal notranslate"><span class="pre">CrystalGraph</span></code></a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#executable-information">Executable Information</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#execution-information">Execution Information</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#key-functions">Key Functions</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#xrdfit"><code class="docutils literal notranslate"><span class="pre">XRDfit</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#parameters">Parameters:</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#returns">Returns:</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#backgroundfit"><code class="docutils literal notranslate"><span class="pre">BackgroundFit</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">Parameters:</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id2">Returns:</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#filetypecovert"><code class="docutils literal notranslate"><span class="pre">FileTypeCovert</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id3">Parameters:</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id4">Returns:</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#amorphous-fit"><code class="docutils literal notranslate"><span class="pre">Amorphous_fit</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id5">Parameters:</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id6">Returns:</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#crygraph"><code class="docutils literal notranslate"><span class="pre">CryGraph</span></code></a><ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id7">Parameters:</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#id8">Returns:</a></li>
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#additional-functions">Additional Functions</a></li>
</ul>
</li>
</ul>
  </nav></div>

</div></div>
              
            
          </div>
          <footer class="bd-footer-content">
            
<div class="bd-footer-content__inner container">
  
  <div class="footer-item">
    
<p class="component-author">
By Bin CAO
</p>

  </div>
  
  <div class="footer-item">
    

  <p class="copyright">
    
      © Copyright 2023.
      <br/>
    
  </p>

  </div>
  
  <div class="footer-item">
    
  </div>
  
  <div class="footer-item">
    
  </div>
  
</div>
          </footer>
        

      </main>
    </div>
  </div>
  
  <!-- Scripts loaded after <body> so the DOM is not blocked -->
  <script src="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b"></script>

  <footer class="bd-footer">
  </footer>
  </body>
</html>