Skip to content

Installation docs update #348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PK0207 wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Installation docs update #348

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9f55f04
Updated installation documentation
PK0207 Apr 14, 2022
dd3db56
Adding line breaks
PK0207 Apr 14, 2022
5ded4bf
retrying line breaks
PK0207 Apr 14, 2022
8d03403
retrying line breaks
PK0207 Apr 14, 2022
79ede9d
just using bullet points instead of line breaks
PK0207 Apr 14, 2022
d0451d9
Formatting issue?
PK0207 Apr 14, 2022
b13443f
Maybe it's indents and enters?
PK0207 Apr 14, 2022
9a36e88
fixing bash code block
PK0207 Apr 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,19 @@ 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.

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:
Expand Down