From 9f55f048cfdbf432554d94d0696694feaf5f1ed9 Mon Sep 17 00:00:00 2001 From: PK0207 <30590837+PK0207@users.noreply.github.com> Date: Thu, 14 Apr 2022 11:28:56 -0700 Subject: [PATCH 1/8] Updated installation documentation Added a note about installing on anaconda, and about the wheel building failure on windows. --- README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.rst b/README.rst index 9123033b3..82d40531b 100644 --- a/README.rst +++ b/README.rst @@ -35,12 +35,15 @@ BANZAI can be installed using pip, by running from the top-level directory conta Note that `pip>=19.3.1` is required to build and install BANZAI. +To run banzai using jupyter notebooks or any other anacode application, you must install banzai from the anaconda terminal using the same procedure. .. code-block:: bash pip install . This will automatically install the dependencies from PyPi, so it is recommended to install BANZAI in a virtual environment. +Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater. +You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` Usage ----- From dd3db561ac3f4f05fc302559a8ae485a40dda375 Mon Sep 17 00:00:00 2001 From: PK0207 <30590837+PK0207@users.noreply.github.com> Date: Thu, 14 Apr 2022 11:29:44 -0700 Subject: [PATCH 2/8] Adding line breaks --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 82d40531b..e75106267 100644 --- a/README.rst +++ b/README.rst @@ -41,8 +41,8 @@ To run banzai using jupyter notebooks or any other anacode application, you must pip install . This will automatically install the dependencies from PyPi, so it is recommended to install -BANZAI in a virtual environment. -Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater. +BANZAI in a virtual environment.
+Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater.
You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` Usage From 5ded4bf66f5d1d8c649be28b54e63ee2db94f148 Mon Sep 17 00:00:00 2001 From: PK0207 <30590837+PK0207@users.noreply.github.com> Date: Thu, 14 Apr 2022 11:31:19 -0700 Subject: [PATCH 3/8] retrying line breaks --- README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index e75106267..397a1ce4c 100644 --- a/README.rst +++ b/README.rst @@ -41,9 +41,9 @@ To run banzai using jupyter notebooks or any other anacode application, you must pip install . This will automatically install the dependencies from PyPi, so it is recommended to install -BANZAI in a virtual environment.
-Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater.
-You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` +BANZAI in a virtual environment. +| Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater. +| You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` Usage ----- From 8d03403ee5ffdd0cb9639b5baf7a72ec4b07ed06 Mon Sep 17 00:00:00 2001 From: PK0207 <30590837+PK0207@users.noreply.github.com> Date: Thu, 14 Apr 2022 11:33:14 -0700 Subject: [PATCH 4/8] retrying line breaks --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 397a1ce4c..1d3949f59 100644 --- a/README.rst +++ b/README.rst @@ -42,8 +42,8 @@ To run banzai using jupyter notebooks or any other anacode application, you must This will automatically install the dependencies from PyPi, so it is recommended to install BANZAI in a virtual environment. -| Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater. -| You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` +| Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater. +| You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` Usage ----- From 79ede9d4dda9d66e730fe22ed2b8035fb79317d7 Mon Sep 17 00:00:00 2001 From: PK0207 <30590837+PK0207@users.noreply.github.com> Date: Thu, 14 Apr 2022 11:34:26 -0700 Subject: [PATCH 5/8] just using bullet points instead of line breaks --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 1d3949f59..652ed789a 100644 --- a/README.rst +++ b/README.rst @@ -42,8 +42,8 @@ To run banzai using jupyter notebooks or any other anacode application, you must This will automatically install the dependencies from PyPi, so it is recommended to install BANZAI in a virtual environment. -| Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater. -| You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` +* Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater. +* You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` Usage ----- From d0451d98bddf33ff25f4b0b7773538037964ee34 Mon Sep 17 00:00:00 2001 From: PK0207 <30590837+PK0207@users.noreply.github.com> Date: Thu, 14 Apr 2022 11:36:17 -0700 Subject: [PATCH 6/8] Formatting issue? I think that the writeup needs to be above the pip install code block. --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 652ed789a..618c26547 100644 --- a/README.rst +++ b/README.rst @@ -34,6 +34,8 @@ Installation BANZAI can be installed using pip, by running from the top-level directory containing `setup.py`. Note that `pip>=19.3.1` is required to build and install BANZAI. +Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater. +You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` To run banzai using jupyter notebooks or any other anacode application, you must install banzai from the anaconda terminal using the same procedure. .. code-block:: bash @@ -42,8 +44,6 @@ To run banzai using jupyter notebooks or any other anacode application, you must This will automatically install the dependencies from PyPi, so it is recommended to install BANZAI in a virtual environment. -* Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater. -* You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` Usage ----- From b13443fe37375e230171f2e02ecb3c6c62480bb6 Mon Sep 17 00:00:00 2001 From: PK0207 <30590837+PK0207@users.noreply.github.com> Date: Thu, 14 Apr 2022 11:37:29 -0700 Subject: [PATCH 7/8] Maybe it's indents and enters? --- README.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 618c26547..4e5c520b1 100644 --- a/README.rst +++ b/README.rst @@ -34,8 +34,6 @@ Installation BANZAI can be installed using pip, by running from the top-level directory containing `setup.py`. Note that `pip>=19.3.1` is required to build and install BANZAI. -Note: If the error: `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater. -You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` To run banzai using jupyter notebooks or any other anacode application, you must install banzai from the anaconda terminal using the same procedure. .. code-block:: bash @@ -45,6 +43,10 @@ To run banzai using jupyter notebooks or any other anacode application, you must This will automatically install the dependencies from PyPi, so it is recommended to install BANZAI in a virtual environment. +If the error `ERROR: Could not build wheels for banzai, which is required to install pyproject.toml-based projects` comes up, on Windows you need to download Microsoft Visual C++ 14.0 or greater. + +You may also need to install lcogt_logging, as it is a separate module. This can be done by running `pip3 install lcogt_logging` + Usage ----- BANZAI has a variety of console entry points: From 9a36e8850a72979d959079e252ee8366228fc4d2 Mon Sep 17 00:00:00 2001 From: PK0207 <30590837+PK0207@users.noreply.github.com> Date: Thu, 14 Apr 2022 12:30:51 -0700 Subject: [PATCH 8/8] fixing bash code block --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index 4e5c520b1..8052a9d6a 100644 --- a/README.rst +++ b/README.rst @@ -36,6 +36,7 @@ BANZAI can be installed using pip, by running from the top-level directory conta Note that `pip>=19.3.1` is required to build and install BANZAI. To run banzai using jupyter notebooks or any other anacode application, you must install banzai from the anaconda terminal using the same procedure. + .. code-block:: bash pip install .