Skip to content

Commit

Permalink
Fix header reference to avoid warning during build
Browse files Browse the repository at this point in the history
- Also add periods and make other little changes according to Brandon's
  comments in the PR
  • Loading branch information
cjsha committed Aug 9, 2024
1 parent 84163a7 commit dd26678
Showing 1 changed file with 23 additions and 25 deletions.
48 changes: 23 additions & 25 deletions articles/getting-started/install-configure-bonsai.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,21 @@ uid: BonsaiInstallationAndConfiguration
title: Bonsai Installation and Configuration
---

# Bonsai Installation and Configuration

## Install Bonsai

To download Bonsai, select between the portable download and the installer download [here](https://bonsai-rx.org/docs/articles/installation.html).

* The **Portable** download installs a self-contained sandboxed Bonsai. Portable environments enable users to switch between different environments to prevent package conflicts or confusion between similar packages
* The **Portable** download installs a sandboxed version of Bonsai. Portable environments enable users to switch between different environments to prevent package conflicts or confusion between similar packages.

* To install from the **Portable** download, extract the downloaded file. You can start the portable Bonsai by running the `Bonsai.exe` that is inside the extracted folder
* To install from the **Portable** download, extract the downloaded file. You can start the portable Bonsai by running the `Bonsai.exe` that is inside the extracted folder.

* The **Installer** download installs Bonsai and all its dependencies globally
* The **Installer** download installs Bonsai and all its dependencies globally.

* To install from the **Installer** download, run the downloaded `Bonsai-X.X.X.exe` file and agree to the involved licenses. You can start the globally installed Bonsai by launching it from the `Bonsai Setup` window after installing or searching for it in your OS's search function, for example
* To install from the **Installer** download, run the downloaded `Bonsai-X.X.X.exe` file and agree to the involved licenses. You can start the globally installed Bonsai by launching it from the `Bonsai Setup` window after installing or searching for it in your OS's search function, for example. You can create a shortcut such that the portable Bonsai environment is easy and name it such that it is easy to differentiate between different environments.

To use Bonsai for interfacing with Open Ephys hardware in a meaningful way, additional packages are required.

<h2 id='open-package-manager'>Open the Bonsai Package Manager</h2>
## Open Bonsai Package Manager

The Bonsai package manager can be accessed from Bonsai's landing window or its workflow editor:

Expand All @@ -37,47 +35,47 @@ Additional packages may be required if you wish to use Bonsai in ways that exten

### Bonsai.StarterPack

Install the `Bonsai.StarterPack` package. [Open the package manager](#open-package-manager) and:
Install the `Bonsai.StarterPack` package. [Open the package manager](#open-bonsai-package-manager) and:

1. Click the `Browse` tab
1. Click the `Browse` tab.

1. Set `Package source` to `Bonsai Packages`
1. Set `Package source` to `Bonsai Packages`.

1. Search for `Bonsai.StarterPack`
1. Search for `Bonsai.StarterPack`.

1. Click `Install`
1. Click `Install`.

![Bonsai Bonsai.StarterPack Install Screenshot](../../images/bonsai-install-Bonsai.StarterPack.webp){width=650px}

### OpenEphys.Onix1

Install the `OpenEphys.Onix1` package. [Open the package manager](#open-package-manager) and:
Install the `OpenEphys.Onix1` package. [Open the package manager](#open-bonsai-package-manager) and:

1. Click the `Browse` tab
1. Click the `Browse` tab.

1. Set `Package source` to `All`
1. Set `Package source` to `All` or `NuGet`.

1. Search `OpenEphys.Onix1`
1. Search `OpenEphys.Onix1`.

1. Click `Install`
1. Click `Install`.

1. Click `I accept` when the license agreement window appears
1. Click `I Accept` when the license agreement window appears.

![Bonsai OpenEphys.Onix1 Install Screenshot](../../images/bonsai-install-OpenEphys.Onix1.webp){width=650px}

## Update Packages in Bonsai

It is good practice to periodically check for package updates. [Open the package manager](#open-package-manager) and:
It is good practice to periodically check for package updates. [Open the package manager](#open-bonsai-package-manager) and:

1. Click the `Update` tab
1. Click the `Update` tab.

1. Set `Package source` to `All`
1. Set `Package source` to `All`.

1. Leave the search bar blank if you want to check for updates for all packages \
Alternatively, if you want to check for an update for a particular package, you may type that package's name in the search bar to expedite the update retrieval process
1. Leave the search bar blank if you want to check for updates for all packages.\
Alternatively, if you want to check for an update for a particular package, you may type that package's name in the search bar to expedite the update retrieval process.

1. Click `Update All` if you want to perform all available updates \
Alternatively, click on a package and click `Update` if you want to perform a subset of the available updates
1. Click `Update All` if you want to perform all available updates.\
Alternatively, click on a package and click `Update` if you want to perform a subset of the available updates.

![Bonsai Update All or Just One Screenshot](../../images/bonsai-update.webp){width=650px}

Expand Down

0 comments on commit dd26678

Please sign in to comment.