update theme to pydata

.gitignore

@@ -3,5 +3,6 @@
 *tempfile*
 .ccls-cache/
 .cache/
+build/
 poetry.lock
 compile_commands.json

docs/build.rst

@@ -1,5 +1,5 @@
 ===========================
-QuickStart -
+QuickStart
 ===========================
 
 .. contents:: 

docs/conf.py

@@ -54,7 +54,7 @@
 #       version to be the same.  For your own projects, you would NOT do this!
 version = "0.0.1"  # exhale.__version__
 # The full version, including alpha/beta/rc tags.
-release = "rc"  # exhale.__version__
+# release = "rc"  # exhale.__version__
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -77,6 +77,23 @@
 #        "donate.html",
 #    ]
 # }
+html_theme_options = {
+    "header_links_before_dropdown": 4,
+    "icon_links": [
+        {
+            # Label for this link
+            "name": "GitHub",
+            # URL where the link will redirect
+            "url": "https://github.com/srbhp/nrgplusplus",  # required
+            # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
+            "icon": "fa-brands fa-square-github",
+            # The type of image to be used (see below for details)
+            "type": "fontawesome",
+        }
+    ],
+}
+html_theme_options = {}
+
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/docnrgcore.rst

@@ -1,4 +1,4 @@
-Core class of the ``nrgcore`` system
+``nrgcore`` class
 ================
 
 .. doxygenclass:: nrgcore

docs/index.rst

@@ -1,3 +1,4 @@
+=========================================================
 nrgplusplus
 =========================================================
 

nrgcore/include/utils/h5stream.hpp

@@ -12,7 +12,7 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 #pragma once
-#include "H5Cpp.h"
+#include <H5Cpp.h>
 #include <iostream>
 #include <stdexcept>
 #include <string>
@@ -81,16 +81,16 @@ namespace h5stream {
 class dspace {
 public:
   H5::DataSet dataset;
-  explicit dspace(const H5::DataSet &datasetx) : dataset(datasetx){};
+  explicit dspace(const H5::DataSet &datasetx) : dataset(datasetx) {};
   /**
    * @brief Write Metadata
    *
-   * @tparam T
-   * @param data
-   * @param dataname
+   * @tparam T : Type of the array
+   * @param data : Array that needs to stored
+   * @param dataname : DataSet name
    */
   template <typename T>
-  void write_atr(const T data, const H5std_string &dataname) {
+  void write_atr(const T &data, const H5std_string &dataname) {
     auto          type           = get_datatype_for_hdf5<T>();
     H5::DataSpace attr_dataspace = H5::DataSpace(H5S_SCALAR);
     H5::Attribute attribute =
@@ -100,9 +100,9 @@ class dspace {
   /**
    * @brief Read Metadata
    *
-   * @tparam T
-   * @param data
-   * @param dataname
+   * @tparam T : Type of the array
+   * @param data : Array that needs to stored
+   * @param dataname : DataSet name
    */
   template <typename T> void read_atr(T &data, const H5std_string &dataname) {
     // auto type = get_datatype_for_hdf5<T>();
@@ -121,13 +121,13 @@ class dspace {
 class gspace { // for group
 public:
   H5::Group dataset;
-  explicit gspace(const H5::Group &datasetx) : dataset(datasetx){};
+  explicit gspace(const H5::Group &datasetx) : dataset(datasetx) {};
   /**
    * @brief Write Metadata
    *
-   * @tparam T
-   * @param data
-   * @param dataname
+   * @tparam T : Type of the array
+   * @param data : Array that needs to stored
+   * @param dataname : DataSet name
    */
   template <typename T>
   void write_atr(const T data, const H5std_string &dataname) {
@@ -140,9 +140,9 @@ class gspace { // for group
   /**
    * @brief Read Metadata
    *
-   * @tparam T
-   * @param data
-   * @param dataname
+   * @tparam T : Type of the array
+   * @param data : Array that needs to stored
+   * @param dataname : DataSet name
    */
   template <typename T> void read_atr(T &data, const H5std_string &dataname) {
     // auto type = get_datatype_for_hdf5<T>();
@@ -302,9 +302,9 @@ class h5stream {
   /**
    * @brief
    *
-   * @param datasetName
-   * @param data
-   * @param data_size
+   * @tparam T : Type of the array
+   * @param data : Array that needs to stored
+   * @param dataname : DataSet name
    */
   template <typename T = double>
   void write(const H5std_string &datasetName, const T *data,
@@ -331,8 +331,8 @@ class h5stream {
   /**
    * @brief
    *
-   * @param data
-   * @param datasetName
+   * @param data : Array that needs to stored
+   * @param dataname : DataSet name
    */
   template <typename T = double, template <typename...> class vec = std::vector>
   void read(vec<T> &data, const H5std_string &datasetName) {
@@ -359,8 +359,8 @@ class h5stream {
   /**
    * @brief Read the data
    *
-   * @param data
-   * @param datasetName
+   * @param data :  Array of data
+   * @param datasetName : dataset name
    */
   template <typename T = double, template <typename...> class vec>
   void read(std::vector<vec<T>> &data, const H5std_string &datasetName) {
@@ -402,7 +402,7 @@ class h5stream {
   /**
    * @brief
    *
-   * @param dataset_name
+   * @param dataset_name : dataset name
    * @return
    */
   dspace getDataspace(const H5std_string &dataset_name) {
@@ -411,7 +411,7 @@ class h5stream {
   /**
    * @brief
    *
-   * @param dataset_name
+   * @param dataset_name : DataSet name
    * @return
    */
   gspace getGroup(const H5std_string &dataset_name) {
@@ -420,7 +420,7 @@ class h5stream {
   /**
    * @brief Create a group name
    *
-   * @param group_name
+   * @param group_name : Group name
    * @return
    */
   auto createGroup(const H5std_string &group_name) {
@@ -430,10 +430,9 @@ class h5stream {
   // write metadata at the root label
   /**
    * @brief Write Metadata
-   *
-   * @tparam T `datatype`
-   * @param data
-   * @param label
+   * @tparam T : Type of the array
+   * @param data : Array that needs to stored
+   * @param dataname : DataSet name
    */
   template <typename T>
   void writeMetadata(const T &data, const H5std_string &label) {
@@ -443,10 +442,10 @@ class h5stream {
   }
   /**
    * @brief
+   * @tparam T : Type of the array
+   * @param data : Array that needs to stored
+   * @param dataname : DataSet name
    *
-   * @tparam T
-   * @param data
-   * @param label
    */
   template <typename T> void readMetadata(T &data, const H5std_string &label) {
     //