Skip to content

Commit

Permalink
Refactor template & implement some of jon's requests (#26)
Browse files Browse the repository at this point in the history
* resolve issues 10, 11, & 32, refactor template & misc.

- Rewrite ManagedReference.extensions.js after actually learning js
- Remove the title in the input/output boxes of the operator diagram ([ ] -> o -> [ ])
- Remove the dataFrame, contextTask, etc. from the operator page
- Remove from reference toc
- Rewrite the template to accomodate more sensible view data model
  structure
- Filter out a couple files that were causing broken references from
  OpenEphys.Onix1.Design in filter.yaml
- .css instead of javascript to remove whitespace in tables
- add image for transfoermer-operator.svg which was originally made for Shawn
- add xcf/webp and write text for Bonsai package uninstallation instructions
- use mref.ext.js to add code tags to first column in tables contained in remarks for reformatting formats
- address PR review from Brandon & edit the device configuration
  disclaimer
- Add PortStatus.bonsai to avoid broken reference in future commit
- Point submodule to earlier commit in latest commit that passes linkchecker
  • Loading branch information
cjsha authored Aug 21, 2024
1 parent fc23b2f commit 90d834c
Show file tree
Hide file tree
Showing 14 changed files with 317 additions and 737 deletions.
17 changes: 16 additions & 1 deletion articles/getting-started/install-configure-bonsai.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ To download Bonsai, select between the portable download and the installer downl
* The **Portable** download (.zip) 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.
* The **Installer** download (.exe) 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. 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 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.

> [!TIP]
> When using multiple environments, create and name shortcuts such that different Bonsai environments are easier to find and distinguish.
## Open Bonsai Package Manager
The Bonsai package manager can be accessed from Bonsai's landing window or its workflow editor:
Expand Down Expand Up @@ -73,6 +76,18 @@ It is good practice to periodically check for package updates. To do this, [open

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

## Uninstall Packages in Bonsai

Sometimes it is helpful to uninstall packages. [Open the package manager](#open-bonsai-package-manager) and:

1. Click the `Installed` tab.
1. Set `Package source` to `All`.
1. Leave the search bar blank if you want to see all installed packages.\
Alternatively, if you want to uninstall a particular package, you may type that package's name in the search bar.
1. Click a package and click `Uninstall` to uninstall a packages.

![Bonsai Uninstall](../../images/bonsai-uninstall-Bonsai.OpenEphys.webp){width=650px}

## Next Steps

Now that Bonsai has been installed and configured, it is time to start constructing a workflow to capture data from your ONIX system. The following sections give a high-level understanding of how Bonsai is organized, and some of the ONIX-specific concepts that will be useful for learning how to work with the operators. If you are familiar with Bonsai, you might want to skip to the <xref:headstages-index> section.
6 changes: 5 additions & 1 deletion filter.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
apiRules:
- exclude:
hasAttribute:
uid: System.ObsoleteAttribute
uid: System.ObsoleteAttribute
- exclude:
uidRegex: OpenEphys.Onix1.Design.NeuropixelsV2eChannelConfigurationDialog
- exclude:
uidRegex: OpenEphys.Onix1.Design.ChannelConfigurationDialog
Binary file added images/bonsai-uninstall-Bonsai.OpenEphys.webp
Binary file not shown.
58 changes: 58 additions & 0 deletions images/transform-operator.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img-src/bonsai-uninstall-Bonsai.OpenEphys.xcf
Binary file not shown.
2 changes: 1 addition & 1 deletion src/onix-bonsai-onix1
Loading

0 comments on commit 90d834c

Please sign in to comment.