updating main page of graphium_cpp

datamol-io · Nov 7, 2024 · 782b500 · 782b500
1 parent 072a4fa
commit 782b500
Show file tree

Hide file tree

Showing 85 changed files with 296 additions and 249 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -42,7 +42,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "Graphium C++"
+PROJECT_NAME           = "graphium_cpp"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
@@ -54,7 +54,7 @@ PROJECT_NUMBER         = 3.0.0
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "C++ accelerations of Graphium's featurization and data loading processes"
+PROJECT_BRIEF          = 
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
@@ -1165,7 +1165,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = ./docs/index.md
+USE_MDFILE_AS_MAINPAGE = README.md
 
 # The Fortran standard specifies that for fixed formatted Fortran code all
 # characters from position 72 are to be considered as comment. A common

diff --git a/README.md b/README.md
@@ -59,8 +59,10 @@ mamba env create -f env.yml -n graphium
 # To force the CUDA version to 11.2, or any other version you prefer, use the following command:
 # CONDA_OVERRIDE_CUDA=11.2 mamba env create -f env.yml -n graphium
 
-# Install Graphium in dev mode
+# Activate the mamba environment containing graphium's dependencies
 mamba activate graphium
+
+# Install Graphium in dev mode
 pip install --no-deps --no-build-isolation -e .
 ```
 

diff --git a/docs/graphium_cpp/docs/annotated.html b/docs/graphium_cpp/docs/annotated.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: Class List</title>
+<title>graphium_cpp: Class List</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/class_one_hot_lookup-members.html b/docs/graphium_cpp/docs/class_one_hot_lookup-members.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: Member List</title>
+<title>graphium_cpp: Member List</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/class_one_hot_lookup.html b/docs/graphium_cpp/docs/class_one_hot_lookup.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: OneHotLookup&lt; NUM_IN, MAX_OUT &gt; Class Template Reference</title>
+<title>graphium_cpp: OneHotLookup&lt; NUM_IN, MAX_OUT &gt; Class Template Reference</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/classes.html b/docs/graphium_cpp/docs/classes.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: Class Index</title>
+<title>graphium_cpp: Class Index</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/commute_8cpp.html b/docs/graphium_cpp/docs/commute_8cpp.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: graphium/graphium_cpp/commute.cpp File Reference</title>
+<title>graphium_cpp: graphium/graphium_cpp/commute.cpp File Reference</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/commute_8h_source.html b/docs/graphium_cpp/docs/commute_8h_source.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: graphium/graphium_cpp/commute.h Source File</title>
+<title>graphium_cpp: graphium/graphium_cpp/commute.h Source File</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/dir_5080f134d77f9705307efbfb3bc63636.html b/docs/graphium_cpp/docs/dir_5080f134d77f9705307efbfb3bc63636.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: graphium/graphium_cpp Directory Reference</title>
+<title>graphium_cpp: graphium/graphium_cpp Directory Reference</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/dir_ac24bae3a88a7603cf2c130a1fec516d.html b/docs/graphium_cpp/docs/dir_ac24bae3a88a7603cf2c130a1fec516d.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: graphium Directory Reference</title>
+<title>graphium_cpp: graphium Directory Reference</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/doxygen_crawl.html b/docs/graphium_cpp/docs/doxygen_crawl.html
@@ -132,6 +132,10 @@
 <a href="graphormer_8cpp.html"/>
 <a href="graphormer_8cpp.html#a70f035fb4ee0f5d8bce42a6f151722e7"/>
 <a href="graphormer_8h_source.html"/>
+<a href="index.html"/>
+<a href="index.html#autotoc_md1"/>
+<a href="index.html#autotoc_md2"/>
+<a href="index.html#autotoc_md3"/>
 <a href="labels_8cpp.html"/>
 <a href="labels_8cpp.html#a27d9eab817696f157915b419b7b1c94b"/>
 <a href="labels_8cpp.html#a27d9eab817696f157915b419b7b1c94ba1e23852820b9154316c7c06e2b7ba051"/>

diff --git a/docs/graphium_cpp/docs/electrostatic_8cpp.html b/docs/graphium_cpp/docs/electrostatic_8cpp.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: graphium/graphium_cpp/electrostatic.cpp File Reference</title>
+<title>graphium_cpp: graphium/graphium_cpp/electrostatic.cpp File Reference</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/electrostatic_8h_source.html b/docs/graphium_cpp/docs/electrostatic_8h_source.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: graphium/graphium_cpp/electrostatic.h Source File</title>
+<title>graphium_cpp: graphium/graphium_cpp/electrostatic.h Source File</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/features_8cpp.html b/docs/graphium_cpp/docs/features_8cpp.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: graphium/graphium_cpp/features.cpp File Reference</title>
+<title>graphium_cpp: graphium/graphium_cpp/features.cpp File Reference</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/features_8h_source.html b/docs/graphium_cpp/docs/features_8h_source.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: graphium/graphium_cpp/features.h Source File</title>
+<title>graphium_cpp: graphium/graphium_cpp/features.h Source File</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/files.html b/docs/graphium_cpp/docs/files.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: File List</title>
+<title>graphium_cpp: File List</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/float__features_8cpp.html b/docs/graphium_cpp/docs/float__features_8cpp.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: graphium/graphium_cpp/float_features.cpp File Reference</title>
+<title>graphium_cpp: graphium/graphium_cpp/float_features.cpp File Reference</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/float__features_8h_source.html b/docs/graphium_cpp/docs/float__features_8h_source.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: graphium/graphium_cpp/float_features.h Source File</title>
+<title>graphium_cpp: graphium/graphium_cpp/float_features.h Source File</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/functions.html b/docs/graphium_cpp/docs/functions.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: Class Members</title>
+<title>graphium_cpp: Class Members</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>

diff --git a/docs/graphium_cpp/docs/functions_vars.html b/docs/graphium_cpp/docs/functions_vars.html
@@ -5,7 +5,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.11.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Graphium C++: Class Members - Variables</title>
+<title>graphium_cpp: Class Members - Variables</title>
 <link rel="icon" href="logo-mini-dark.png" type="image/x-icon" />
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
@@ -27,9 +27,8 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="logo-mini-white-doxygen.png"/></td>
   <td id="projectalign">
-   <div id="projectname">Graphium C++<span id="projectnumber">&#160;3.0.0</span>
+   <div id="projectname">graphium_cpp<span id="projectnumber">&#160;3.0.0</span>
    </div>
-   <div id="projectbrief">C++ accelerations of Graphium&#39;s featurization and data loading processes</div>
   </td>
  </tr>
  </tbody>