fix Github action

Author: fancaiyu

.github/workflows/CI.yml

@@ -3,10 +3,10 @@ name: CI
 on: 
   push:
     branches:
-      - master
+      - cyfan
   pull_request:
     branches:
-      - master
+      - cyfan
 
 permissions:
   contents: write
@@ -43,7 +43,7 @@ jobs:
 
       - name: Run tests
         run: |
-          export PYTHONPATH=src
+          export PYTHONPATH=MCintegration
           pytest --cov --cov-report=xml
 
       - name: Upload coverage to Codecov
@@ -68,8 +68,8 @@ jobs:
       - name: Build documentation
         run: |
           cd docs
-          sphinx-apidoc -o source ../src ../src/*_test.py
-          python ../clean_src_rst.py
+          sphinx-apidoc -o source ../MCintegration ../MCintegration/*_test.py
+          python ../clean_MCintegration_rst.py
           make html
           python ../clean_html_sidebar.py
 

MCintegration/utils.py

@@ -148,7 +148,7 @@ def summary(self, weighted=None):
         Args:
             weighted (bool): Display weighted averages of results from different
                 iterations if ``True``; otherwise show unweighted averages.
-                Default behavior is determined by |vegas|.
+                Default behavior is determined by vegas.
         """
         if weighted is None:
             weighted = self.weighted

clean_MCintegration_rst.py

@@ -0,0 +1,20 @@
+import re
+
+def remove_prefix_and_horizontal_lines(filename):
+    with open(filename, 'r') as file:
+        lines = file.readlines()
+
+    cleaned_lines = []
+    
+    for i, line in enumerate(lines):
+        if re.match(r"^[A-Za-z0-9._ ]+ module", line.strip()) and 'MCintegration.' in line:
+            cleaned_lines.append(line.replace('MCintegration.', '').strip() + '\n')
+        elif line.strip().startswith('.. automodule::'):
+            cleaned_lines.append(line)
+        else:
+            cleaned_lines.append(line)
+
+    with open(filename, 'w') as file:
+        file.writelines(cleaned_lines)
+
+remove_prefix_and_horizontal_lines('./source/MCintegration.rst')

clean_html_sidebar.py

@@ -6,17 +6,13 @@ def remove_class_prefix_from_sidebar(html_file):
 
     soup = BeautifulSoup(content, 'html.parser')
 
-    # 找 class="sphinxsidebarwrapper" 侧边栏
     sidebar = soup.find('div', class_='sphinxsidebarwrapper')
 
     if sidebar:
-        # 找 class="pre" 的 span 标签
         for span in sidebar.find_all('span', class_='pre'):
             text = span.get_text()
-            # 删除 '.' 之前的内容
             if '.' in text:
                 method_name = text.split('.')[1] 
-                # 更新 <a> 标签，保证跳转有效
                 for a_tag in sidebar.find_all('a', class_='reference internal'):
                     if text in a_tag.get_text():
                         href = a_tag['href']
@@ -36,5 +32,5 @@ def remove_class_prefix_from_sidebar(html_file):
     else:
         print("No sidebar found in the HTML.")
 
-input_html = './build/html/src.html'
+input_html = './build/html/MCintegration.html'
 remove_class_prefix_from_sidebar(input_html)

clean_src_rst.py

@@ -8,7 +8,7 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('../../src'))
+sys.path.insert(0, os.path.abspath('../..'))
 
 project = 'MCintegration'
 copyright = '2024, Authors'
@@ -25,11 +25,6 @@
     'sphinx.ext.autosummary'
 ]
 
-templates_path = ['_templates']
-exclude_patterns = []
-
-
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
@@ -56,7 +51,5 @@
 napoleon_use_param = True
 napoleon_use_rtype = True
 
-html_theme = 'sphinxdoc'
-html_theme = 'nature'
 html_theme = 'pyramid'
 html_static_path = ['_static']

docs/source/conf.py

@@ -4,14 +4,14 @@
    contain the root `toctree` directive.
 
 MCintegration documentation
-===============
-
+===========================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+
+   test_result.rst
 
 Indices and tables
 ==================

docs/source/index.rst

@@ -0,0 +1,43 @@
+Table of test results
+=======================================
+
+Multigpu Test
+---------------------------------------
+
+eval = 400000
+
+   +---------------------------+---------------+-----------------+-----------------+
+   | Configuration             | Integration   | eval*16/ngpu    | eval*64/ngpu    |
+   +===========================+===============+=================+=================+
+   |                           | mc            | 3.14100 (64)    | 3.14156 (32)    |
+   |                           |               |                 |                 |
+   |                           |               | 20.02ms         | 79.87ms         |
+   | 1DCU (1node, 8cpu cores)  +---------------+-----------------+-----------------+
+   |                           | mcmc          | 3.14152 (65)    | 3.14090 (33)    |
+   |                           |               |                 |                 |
+   |                           |               | 58.57ms         | 234ms           |
+   +---------------------------+---------------+-----------------+-----------------+
+   |                           | mc            | 3.14137 (65)    | 3.14123 (33)    |
+   |                           |               |                 |                 |
+   |                           |               | 11.33ms         | 42.22ms         |
+   | 2DCU (1node, 16cpu cores) +---------------+-----------------+-----------------+
+   |                           | mcmc          | 3.14129 (65)    | 3.14157 (32)    |
+   |                           |               |                 |                 |
+   |                           |               | 32.18ms         | 123ms           |
+   +---------------------------+---------------+-----------------+-----------------+
+   |                           | mc            | 3.14182 (65)    | 3.14173 (32)    |
+   |                           |               |                 |                 |
+   |                           |               | 6.08ms          | 22.32ms         |
+   | 4DCU (1node, 32cpu cores) +---------------+-----------------+-----------------+
+   |                           | mcmc          | 3.14260 (65)    | 3.14175 (33)    |
+   |                           |               |                 |                 |
+   |                           |               | 17.34ms         | 64.69ms         |
+   +---------------------------+---------------+-----------------+-----------------+
+   |                           | mc            | 3.14049 (65)    | 3.14150 (32)    |
+   |                           |               |                 |                 |
+   |                           |               | 3.73ms          | 11.55ms         |
+   | 8DCU (2node, 64cpu cores) +---------------+-----------------+-----------------+
+   |                           | mcmc          | 3.14313 (65)    | 3.14149 (33)    |
+   |                           |               |                 |                 |
+   |                           |               | 10.47ms         | 32.39ms         |
+   +---------------------------+---------------+-----------------+-----------------+