Merge pull request #234 from jpgill86/api-tutorial

Add API tutorial to example Jupyter notebook

.gitignore

@@ -1,6 +1,7 @@
 # Specific to this project
 /neurotic/version.py
 /neurotic/example/example-data/
+/neurotic/example/demo.yml
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.rst

@@ -226,8 +226,8 @@ To inspect the metadata file associated with the example or to make changes to
 it, click "Edit metadata". See `Configuring Metadata`_ for details about the
 format.
 
-If you prefer Jupyter notebooks, you can launch an example notebook instead for
-experimenting with **neurotic**'s API::
+If you prefer Jupyter notebooks, you can launch an example notebook instead,
+which includes a tutorial for using **neurotic**'s API::
 
     neurotic --launch-example-notebook
 

docs/gettingstarted.rst

@@ -22,8 +22,8 @@ To inspect the metadata file associated with the example or to make changes to
 it, click "Edit metadata". See :ref:`config-metadata` for details about the
 format.
 
-If you prefer Jupyter notebooks, you can launch an example notebook instead for
-experimenting with **neurotic**'s API::
+If you prefer Jupyter notebooks, you can launch an example notebook instead,
+which includes a tutorial for using **neurotic**'s API::
 
     neurotic --launch-example-notebook
 

neurotic/datasets/metadata.py

@@ -105,6 +105,16 @@ def select(self, selection):
         else:
             self._selection = selection
 
+    @property
+    def keys(self):
+        """
+        The available metadata keys.
+        """
+        if self.all_metadata is None:
+            return None
+        else:
+            return list(self.all_metadata.keys())
+
     @property
     def selected_metadata(self):
         """
@@ -148,22 +158,40 @@ def download_all_data_files(self, **kwargs):
         _download_all_data_files(self.selected_metadata, **kwargs)
 
     def __iter__(self, *args):
-        return self.selected_metadata.__iter__(*args)
+        if self.selected_metadata is None:
+            logger.error('No metadata set is selected. Use the select() method first.')
+        else:
+            return self.selected_metadata.__iter__(*args)
 
     def __getitem__(self, *args):
-        return self.selected_metadata.__getitem__(*args)
+        if self.selected_metadata is None:
+            logger.error('No metadata set is selected. Use the select() method first.')
+        else:
+            return self.selected_metadata.__getitem__(*args)
 
     def __setitem__(self, *args):
-        return self.selected_metadata.__setitem__(*args)
+        if self.selected_metadata is None:
+            logger.error('No metadata set is selected. Use the select() method first.')
+        else:
+            return self.selected_metadata.__setitem__(*args)
 
     def __delitem__(self, *args):
-        return self.selected_metadata.__delitem__(*args)
+        if self.selected_metadata is None:
+            logger.error('No metadata set is selected. Use the select() method first.')
+        else:
+            return self.selected_metadata.__delitem__(*args)
 
     def get(self, *args):
-        return self.selected_metadata.get(*args)
+        if self.selected_metadata is None:
+            logger.error('No metadata set is selected. Use the select() method first.')
+        else:
+            return self.selected_metadata.get(*args)
 
     def setdefault(self, *args):
-        return self.selected_metadata.setdefault(*args)
+        if self.selected_metadata is None:
+            logger.error('No metadata set is selected. Use the select() method first.')
+        else:
+            return self.selected_metadata.setdefault(*args)
 
 
 def _load_metadata(file = 'metadata.yml', local_data_root = None, remote_data_root = None):