DOC: describe the new function, mention in the tutorial

Author: ctrltz

docs/conf.py

@@ -113,6 +113,8 @@ def linkcode_resolve(domain, info):
     "SourceEstimate": "mne.SourceEstimate",
     # MEEGsim
     "SourceConfiguration": "meegsim.configuration.SourceConfiguration",
+    "PointSource": "meegsim.sources.PointSource",
+    "PatchSource": "meegsim.sources.PatchSource",
 }
 numpydoc_xref_ignore = {
     "type",

docs/user_guide/get_started/configuration.rst

@@ -53,3 +53,15 @@ specific value of the ``random_state`` as shown below:
 
 The resulting source configuration, including the locations and waveforms of all
 sources, will be the same on every call.
+
+Accessing the simulated sources
+===============================
+
+The simulated sources can be quickly accessed by their name (`"source"` in the
+example below). This might be helpful in case ground-truth waveforms were
+generated randomly:
+
+.. code-block:: python
+
+    s = sc["source"]
+    gt = s.waveform

src/meegsim/configuration.py

@@ -45,6 +45,26 @@ def __init__(self, src, sfreq, duration, random_state=None):
         self._noise_sources = {}
 
     def __getitem__(self, name):
+        """
+        This function provides quick access to the simulated sources, the syntax
+        is similar to list/dict access: ``sc[name]`` returns the corresponding source
+        if it is present in the configuration.
+
+        Parameters
+        ----------
+        name : str
+            Name of the source.
+
+        Returns
+        -------
+        source : PointSource or PatchSource
+            The corresponding source.
+
+        Raises
+        ------
+        ValueError
+            In case there is no source with the provided name.
+        """
         check_if_source_exists(
             name,
             list(self._sources.keys()),