Documentation pull

.github/workflows/build_docs_html.yml

@@ -0,0 +1,53 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the "main" branch
+  push:
+    branches: [ "main", "develop" ]
+  pull_request:
+    branches: [ "main", "develop" ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
+
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+
+      #- name: Install Dependencies
+      #  run: |
+      #    python -m pip install --upgrade pip
+      #    pip install -r docs/requirements-docs.txt
+      #    sudo apt-get install pandoc -y
+
+      - name: Test sphinx-build
+      - uses: ammaraskar/sphinx-action@master
+        with:
+          docs-folder: "docs/"
+          build-command: "sphinx-build -W -nT -b dummy ./docs/source build/html"
+
+      # Runs a single command using the runners shell
+      - name: Run a one-line script
+        run: echo Hello, world!
+
+      # Runs a set of commands using the runners shell
+      - name: Run a multi-line script
+        run: |
+          echo Add other actions to build,
+          echo test, and deploy your project.

README.md

@@ -6,6 +6,27 @@ An earlier, Matlab-based version of Bento is available [here](https://github.com
 
 ## New In This Release
 
+### Version 0.3.0-beta
+#### Added Features
+- Plug-ins supporting display of MARS, DLC, and SLEAP pose files
+- Support for loading and displaying annotations made in Bento, BORIS, SimBA, and the Caltech Behavior Annotator
+- Plug-ins for event-triggered-averaging of neural activity, and for k-means clustering of neurons based on activity over the full trial
+- Export of your experimental data (neural recording, pose, behavior annotations) to a NWB file
+- Main window now supports jumping to a specific time or frame number in a video
+- Added button to delete files from a trial (though you can still also use the delete key)
+- Simplified setup of the conda environment, removing OS-specific environment files
+
+#### Bugs Fixed
+- Desynced scrolling/display of annotations + neural traces has been fixed
+- Editing trials in v0.2.0-beta caused an increment in the trial number; this is now fixed
+- Widgets are now cleared out when new data is loaded
+
+## Getting Started
+
+- Please look for the installation instructions at [Installation Instructions](https://github.com/neuroethology/bento/blob/main/documentation/installation.md)
+- Please look for the detailed step by step instructions at [Tutorial](https://github.com/neuroethology/bento/blob/main/documentation/tutorial.md)
+
+## Previous Release Updates
 ### Version 0.2.0-beta
 #### Added Features
 - A plug-in interface to support import and display of pose data
@@ -18,12 +39,6 @@ An earlier, Matlab-based version of Bento is available [here](https://github.com
 - On initial startup when no Investigators yet exist, v0.1.0-beta would prompt for the selection of an Investigator anyway.
 With this release, it takes you to the "Add Investigators" dialog instead.
 - The vertical scaling of annotations has been fixed.
-## Features
-
-## Getting Started
-
-- Please look for the installation instructions at [Installation Instructions](https://github.com/neuroethology/bento/blob/main/documentation/installation.md)
-- Please look for the detailed step by step instructions at [Tutorial](https://github.com/neuroethology/bento/blob/main/documentation/tutorial.md)
 
 ## Citation
 

bento.yml

@@ -0,0 +1,31 @@
+name: bento
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - cryptography
+  - gst-plugins-bad
+  - gst-plugins-good
+  - gst-plugins-base
+  - gstreamer
+  - h5py
+  - matplotlib-base
+  - pip
+  - progressbar
+  - pynwb
+  - pyside2
+  - python
+  - qtpy
+  - scikit-learn
+  - scikit-video
+  - sortedcontainers
+  - sqlalchemy
+  - vispy
+  - xlrd
+  - pip:
+    - colour-demosaicing
+    - colour-science
+    - ndx-pose
+    - opencv-python-headless
+    - pymatreader
+    - qimage2ndarray