fixing some cite issues

docs/source/index.rst

@@ -87,11 +87,13 @@ A full exhaustive list of publications can be found on the `CEMeNT site <https:/
 
 .. sidebar-links::
     :caption: Links
-    :github: 
     :pypi: mcdc
+    :github:
+
     CEMeNT <https://cement-psaap.github.io>
     license <https://github.com/CEMeNT-PSAAP/MCDC/blob/main/LICENSE>
 
+
 Indices and tables
 ==================
 

docs/source/install.rst

@@ -4,8 +4,20 @@
 Installation Guide
 ===================
 
-This outlines the basic steps to install MC/DC on a local
-machine or on HPC machine.
+Most users should be able to install MC/DC using,
+.. code-block:: sh
+
+    pip install mcdc
+
+provided they have,
+
+#. a working version of openMPI (from sources like conda, brew, or apt)
+#. have administrator privileges or are using environment managers like conda
+#. are using a `unix` based (`macOS`, `linux`, etc.)
+#. are not trying to develope
+
+The rest of this guide outlines the basic steps to install MC/DC for development, on a local
+machine, or on HPC machine. The is the most resilient way to get the dependencies configured properly.
 
 -----------------------------------
 Creating an MC/DC Conda environment

install.sh

@@ -11,26 +11,7 @@ conda install numpy numba matplotlib scipy h5py pytest colorama <<< "y"
 # Installing visualization dependencies (required via pip for osx-arm64)
 pip install ngsolve distinctipy
 
-# Patch numba
-s=$(python -c 'import numba; print(numba.__path__[0])')
-s+='/core/types/scalars.py'
-
-line=$(grep -n 'class Boolean(Hashable):' $s | cut -f1 -d:)
-
-head -n $line $s > tmp-scalars.py
-cat >> tmp-scalars.py << EOF
-    def __init__(self, name):
-        super(Boolean, self).__init__(name)
-        self.bitwidth = 8
-EOF
-
-length=$(wc -l < $s)
-let "length -= line"
-tail -n $length $s >> tmp-scalars.py
-
-mv tmp-scalars.py $s
-
-
+bash patch_numba.sh
 
 # Install or build mpi4py
 if [ $# -eq 0 ]; then

patch_numba.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# Patch numba
+s=$(python -c 'import numba; print(numba.__path__[0])')
+s+='/core/types/scalars.py'
+
+line=$(grep -n 'class Boolean(Hashable):' $s | cut -f1 -d:)
+
+head -n $line $s > tmp-scalars.py
+cat >> tmp-scalars.py << EOF
+    def __init__(self, name):
+        super(Boolean, self).__init__(name)
+        self.bitwidth = 8
+EOF
+
+length=$(wc -l < $s)
+let "length -= line"
+tail -n $length $s >> tmp-scalars.py
+
+mv tmp-scalars.py $s
+

pyproject.toml

@@ -12,7 +12,7 @@ description = "Monte Carlo / Dynamic Code, a pure python high preofmrance Monte
 readme = "README.md"
 requires-python = ">=3.9, <=3.11.7"
 license = {file = "LICENSE"}
-keywords = ["egg", "bacon", "sausage", "tomatoes", "Lobster Thermidor"]
+keywords = ["Monte Carlo", "Nuclear", "GPU", "numba", "mpi4py", "neutron transport", "neutronics", "HPC"]
 classifiers = [
     "Programming Language :: Python :: 3",
     'License :: OSI Approved :: BSD License',