Merge pull request #418 from AllenNeuralDynamics/dev

Implement Dataverse picker

Author: bruno-f-cruz

.gitattributes

@@ -1,4 +1,4 @@
 * text=auto
 *.cmd text eol=crlf
 *.bat text eol=crlf
-*.bonsai text
+*.bonsai text

.github/workflows/vr-foraging-cicd.yml

@@ -92,8 +92,13 @@ jobs:
           enable-cache: true
 
       - name: Bump pre-release by default
-        run: uv version --bump rc
-
+        shell: bash
+        run: |
+          if uv version --bump rc --dry-run; then
+            uv version --bump rc
+          else
+            uv version --bump rc --bump patch
+          fi
       - name: Regenerate schemas
         run: uv run vr-foraging regenerate
 

README.md

@@ -1,6 +1,6 @@
 # aind-vr-foraging
 
-![CI](https://github.com/AllenNeuralDynamics/Aind.Behavior.VrForaging/actions/workflows/ci.yml/badge.svg)
+![CI](https://github.com/AllenNeuralDynamics/Aind.Behavior.VrForaging/actions/workflows/vr-foraging-cicd.yml/badge.svg)
 [![PyPI - Version](https://img.shields.io/pypi/v/aind-behavior-vr-foraging)](https://pypi.org/project/aind-behavior-vr-foraging/)
 [![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
 [![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

examples/clabe.yml

@@ -17,3 +17,8 @@ default_behavior_picker:
 curriculum:
   script: "curriculum run"
   project_directory: "./src/aind_behavior_vr_foraging/curricula/aind.Behavior.VrForaging.Curricula"
+
+dataverse:
+  tenant_id: "32669cd6-737f-4b39-8bdd-d6951120d3fc"
+  client_id: "df37356e-3316-484a-b732-319b6b4ad464"
+  org: "org5d93e08d"

pyproject.toml

@@ -31,8 +31,8 @@ Changelog = "https://github.com/AllenNeuralDynamics/Aind.Behavior.VrForaging/rel
 data = ["contraqctor<0.5.0"]
 
 launcher = [
-    "aind-clabe[aind-services]",
-    "aind-data-schema>2",
+    "aind-clabe[aind-services]>=0.7",
+    "aind-data-schema>=2",
     "aind_behavior_vr_foraging[data]",
     ]
 

src/DataSchemas/aind_behavior_vr_foraging.json

@@ -3,21 +3,29 @@
     "AindBehaviorSessionModel": {
       "properties": {
         "aind_behavior_services_pkg_version": {
-          "default": "0.12.1",
+          "default": "0.12.2",
           "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
           "title": "aind_behavior_services package version",
           "type": "string"
         },
         "version": {
-          "const": "0.3.1",
-          "default": "0.3.1",
+          "const": "0.12.2",
+          "default": "0.12.2",
           "title": "Version",
           "type": "string"
         },
         "experiment": {
+          "default": null,
           "description": "Name of the experiment",
-          "title": "Experiment",
-          "type": "string"
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Experiment"
         },
         "experimenter": {
           "default": [],
@@ -41,7 +49,7 @@
         },
         "session_name": {
           "default": null,
-          "description": "Name of the session. This will be used to create a folder in the root path.",
+          "description": "Name of the session. This will be used to create a folder in the root path. If not provided, it will be generated using subject and date.",
           "oneOf": [
             {
               "type": "string"
@@ -58,6 +66,8 @@
           "type": "string"
         },
         "experiment_version": {
+          "default": "",
+          "deprecated": true,
           "description": "Version of the experiment",
           "title": "Experiment Version",
           "type": "string"
@@ -102,10 +112,8 @@
         }
       },
       "required": [
-        "experiment",
         "root_path",
-        "subject",
-        "experiment_version"
+        "subject"
       ],
       "title": "AindBehaviorSessionModel",
       "type": "object"
@@ -345,7 +353,7 @@
     "AindVrForagingRig": {
       "properties": {
         "aind_behavior_services_pkg_version": {
-          "default": "0.12.1",
+          "default": "0.12.2",
           "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
           "title": "aind_behavior_services package version",
           "type": "string"
@@ -603,7 +611,7 @@
           "title": "Rng Seed"
         },
         "aind_behavior_services_pkg_version": {
-          "default": "0.12.1",
+          "default": "0.12.2",
           "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
           "title": "aind_behavior_services package version",
           "type": "string"
@@ -739,6 +747,7 @@
       "type": "object"
     },
     "BetaDistribution": {
+      "description": "A beta probability distribution.\n\nContinuous distribution bounded between 0 and 1. Commonly used\nfor modeling probabilities and proportions.",
       "properties": {
         "family": {
           "const": "Beta",
@@ -784,6 +793,7 @@
       "type": "object"
     },
     "BetaDistributionParameters": {
+      "description": "Parameters for a beta distribution.\n\nDefined by alpha and beta shape parameters.",
       "properties": {
         "family": {
           "const": "Beta",
@@ -810,6 +820,7 @@
       "type": "object"
     },
     "BinomialDistribution": {
+      "description": "A binomial probability distribution.\n\nModels the number of successes in a fixed number of independent\nBernoulli trials with constant success probability.",
       "properties": {
         "family": {
           "const": "Binomial",
@@ -855,6 +866,7 @@
       "type": "object"
     },
     "BinomialDistributionParameters": {
+      "description": "Parameters for a binomial distribution.\n\nDefined by number of trials (n) and success probability (p).",
       "properties": {
         "family": {
           "const": "Binomial",
@@ -1646,6 +1658,7 @@
       "type": "object"
     },
     "ExponentialDistribution": {
+      "description": "An exponential probability distribution.\n\nModels time between events in a Poisson process. Commonly used\nfor wait times and inter-event intervals.",
       "properties": {
         "family": {
           "const": "Exponential",
@@ -1690,6 +1703,7 @@
       "type": "object"
     },
     "ExponentialDistributionParameters": {
+      "description": "Parameters for an exponential distribution.\n\nDefined by the rate parameter (inverse of mean).",
       "properties": {
         "family": {
           "const": "Exponential",
@@ -1709,6 +1723,7 @@
       "type": "object"
     },
     "GammaDistribution": {
+      "description": "A gamma probability distribution.\n\nGeneralizes the exponential distribution. Used for modeling\npositive continuous variables with right-skewed distributions.",
       "properties": {
         "family": {
           "const": "Gamma",
@@ -1754,6 +1769,7 @@
       "type": "object"
     },
     "GammaDistributionParameters": {
+      "description": "Parameters for a gamma distribution.\n\nDefined by shape (k) and rate (\u03b8\u207b\u00b9) parameters.",
       "properties": {
         "family": {
           "const": "Gamma",
@@ -2245,6 +2261,7 @@
       "type": "object"
     },
     "LogNormalDistribution": {
+      "description": "A log-normal probability distribution.\n\nDistribution where the logarithm of the variable is normally distributed.\nAlways produces positive values and is right-skewed.",
       "properties": {
         "family": {
           "const": "LogNormal",
@@ -2290,6 +2307,7 @@
       "type": "object"
     },
     "LogNormalDistributionParameters": {
+      "description": "Parameters for a log-normal distribution.\n\nDefined by the mean and standard deviation of the underlying normal distribution.",
       "properties": {
         "family": {
           "const": "LogNormal",
@@ -2473,6 +2491,7 @@
       "type": "object"
     },
     "NormalDistribution": {
+      "description": "A normal (Gaussian) probability distribution.\n\nBell-shaped distribution symmetric around the mean, commonly used\nfor modeling naturally occurring random variables.",
       "properties": {
         "family": {
           "const": "Normal",
@@ -2518,6 +2537,7 @@
       "type": "object"
     },
     "NormalDistributionParameters": {
+      "description": "Parameters for a normal (Gaussian) distribution.\n\nDefined by mean (center) and standard deviation (spread).",
       "properties": {
         "family": {
           "const": "Normal",
@@ -3611,6 +3631,7 @@
       "type": "object"
     },
     "PdfDistribution": {
+      "description": "A custom probability density function distribution.\n\nAllows defining arbitrary discrete distributions by specifying\nprobability values and their corresponding indices.",
       "properties": {
         "family": {
           "const": "Pdf",
@@ -3660,6 +3681,7 @@
       "type": "object"
     },
     "PdfDistributionParameters": {
+      "description": "Parameters for a custom probability density function distribution.\n\nDefined by explicit probability values and their corresponding indices.\nProbabilities are automatically normalized to sum to 1.",
       "properties": {
         "family": {
           "const": "Pdf",
@@ -3762,6 +3784,7 @@
       "type": "object"
     },
     "PoissonDistribution": {
+      "description": "A Poisson probability distribution.\n\nModels the number of events occurring in a fixed interval of time or space\nwhen events occur independently at a constant rate.",
       "properties": {
         "family": {
           "const": "Poisson",
@@ -3806,6 +3829,7 @@
       "type": "object"
     },
     "PoissonDistributionParameters": {
+      "description": "Parameters for a Poisson distribution.\n\nDefined by the rate parameter (average number of events).",
       "properties": {
         "family": {
           "const": "Poisson",
@@ -4040,6 +4064,7 @@
       "type": "object"
     },
     "Scalar": {
+      "description": "A scalar distribution that returns a constant value.\n\nUseful for fixed parameters that don't vary across trials or samples.",
       "properties": {
         "family": {
           "const": "Scalar",
@@ -4072,6 +4097,7 @@
       "type": "object"
     },
     "ScalarDistributionParameter": {
+      "description": "Parameters for a scalar (constant) distribution.\n\nRepresents a deterministic value that always returns the same number.",
       "properties": {
         "family": {
           "const": "Scalar",
@@ -4090,6 +4116,7 @@
       "type": "object"
     },
     "ScalingParameters": {
+      "description": "Parameters for scaling and offsetting sampled distribution values.\nScaling is applied as (value * scale + offset).\n\nApplies linear transformation: result = (value * scale) + offset.",
       "properties": {
         "scale": {
           "default": 1,
@@ -4970,13 +4997,8 @@
       "type": "object"
     },
     "TruncationParameters": {
+      "description": "Parameters for truncating a distribution to a specified range. Truncation should\nbe applied after sampling and scaling.\n\nUsed to constrain sampled values within minimum and maximum bounds.",
       "properties": {
-        "is_truncated": {
-          "default": false,
-          "description": "Whether the distribution is truncated",
-          "title": "Is Truncated",
-          "type": "boolean"
-        },
         "min": {
           "default": 0,
           "description": "Minimum value of the sampled distribution",
@@ -4994,6 +5016,7 @@
       "type": "object"
     },
     "UniformDistribution": {
+      "description": "A uniform probability distribution.\n\nAll values between min and max have equal probability of being sampled.",
       "properties": {
         "family": {
           "const": "Uniform",
@@ -5039,6 +5062,7 @@
       "type": "object"
     },
     "UniformDistributionParameters": {
+      "description": "Parameters for a uniform distribution.\n\nDefined by minimum and maximum bounds of the distribution.",
       "properties": {
         "family": {
           "const": "Uniform",