From 67bcded95a685173235c70b7ee7c3d80734c01b7 Mon Sep 17 00:00:00 2001
From: Steph Prince <40640337+stephprince@users.noreply.github.com>
Date: Thu, 19 Sep 2024 14:45:02 -0700
Subject: [PATCH] Add dataset to store list of software that produced a file
 (#578)

* add nwbfile dataset for provenance information

* update software version dataset name and doc

* update release notes
---
 core/nwb.file.yaml                          | 12 ++++++++++++
 docs/format/source/format_release_notes.rst |  2 +-
 2 files changed, 13 insertions(+), 1 deletion(-)

diff --git a/core/nwb.file.yaml b/core/nwb.file.yaml
index 3997cc2..f3232ed 100644
--- a/core/nwb.file.yaml
+++ b/core/nwb.file.yaml
@@ -241,6 +241,18 @@ groups:
       - name: file_name
         dtype: text
         doc: Name of script file.
+    - name: was_generated_by
+      dtype: text
+      doc: Name and version of software package(s) used to generate data contained in
+       this NWB File. For each software package or library, include the name of the
+       software as the first value and the version as the second value.
+      dims:
+      - num_sources
+      - name, version
+      shape:
+      - null
+      - 2
+      quantity: '?'
     - name: stimulus
       dtype: text
       doc: Notes about stimuli, such as how and where they were presented.
diff --git a/docs/format/source/format_release_notes.rst b/docs/format/source/format_release_notes.rst
index b5b837e..74225e4 100644
--- a/docs/format/source/format_release_notes.rst
+++ b/docs/format/source/format_release_notes.rst
@@ -12,7 +12,7 @@ Minor changes
   ``waveform_sd`` columns ragged. This allows for a different number of waveform means/SDs per unit which is useful
   when each unit is associated with a different number of electrodes and there is a waveform mean/SD for each
   electrode and unit. (#576)
-
+- Added optional ``was_generated_by`` attribute to ``NWBFile`` to store provenance information (#578)
 
 2.7.0 (February 7, 2024)
 ------------------------