Repository: wright-group/WrightTools

Issue:
Installation rst page

distribute example datasets
I'm thinking that we should distribute example datasets to all users.

The syntax would be dead simple:

```
import WrightTools as wt
from WrightTools import datasets

p = datasets.KENT.LDS821_TRSF
```

`p` would be the filepath(s) to the datasets, appropriate for loading using `wt.data.from_KENT(p)`.

@ksunden @darienmorrow comments?
Index Landing page rst



Discussion:

Resolving patch:
diff --git a/WrightTools/datasets/__init__.py b/WrightTools/datasets/__init__.py
new file mode 100644
--- /dev/null
+++ b/WrightTools/datasets/__init__.py
@@ -0,0 +1,60 @@
+"""
+"""
+
+
+### import ########################################################################################
+
+
+import os
+
+
+### define ########################################################################################
+
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+
+### container class ###############################################################################
+
+
+def clean_name(n, prefix=''):
+    illegals = [' ', '[', ']']
+    for c in illegals:
+        n = n.replace(c, '_')
+    return prefix + n
+
+
+class DatasetContainer(object):
+    
+    def from_files(self, dirname, prefix=''):
+        ps = [os.path.join(here, dirname, p) for p in os.listdir(os.path.join(here, dirname))]
+        for p in ps:
+            n = clean_name(os.path.basename(p).split('.')[0], prefix=prefix)
+            setattr(self, n, p)
+    
+    def from_directory(self, dirname, prefix=''):
+        ps = [os.path.join(here, dirname, p) for p in os.listdir(os.path.join(here, dirname))]
+        n = clean_name(os.path.basename(dirname), prefix=prefix)
+        setattr(self, n, ps)
+
+
+### fill ##########################################################################################
+
+
+COLORS = DatasetContainer()
+COLORS.from_files(os.path.join('COLORS', 'v0.2'), prefix='v0p2_')
+COLORS.from_directory(os.path.join('COLORS', 'v2.1', 'MoS2 TrEE movie'), prefix='v2p1_')
+
+JASCO = DatasetContainer()
+JASCO.from_files('JASCO')
+
+KENT = DatasetContainer()
+KENT.from_directory(os.path.join('KENT', 'LDS821 TRSF'))
+KENT.from_directory(os.path.join('KENT', 'PbSe 2D delay A'))
+KENT.from_directory(os.path.join('KENT', 'PbSe 2D delay B'))
+
+
+### pretty namespace ##############################################################################
+
+
+__all__ = ['COLORS', 'JASCO', 'KENT']
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,193 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# WrightTools documentation build configuration file, created by
+# sphinx-quickstart on Tue Jul 18 13:01:20 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../WrightTools'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'numpydoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'WrightTools'
+copyright = '2016-2017, WrightTools Developers'
+author = 'WrightTools Developers'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '2.13.1'
+# The full version, including alpha/beta/rc tags.
+release = '2.13.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# HTML context adapted from http://docs.readthedocs.io/en/latest/vcs.html
+html_context = {
+    "display_github": True, # Integrate GitHub
+    "github_user": "wright-group", # Username
+    "github_repo": "WrightTools", # Repo name
+    "github_version": "documentation", # Version
+    "conf_py_path": "/docs/", # Path in the checkout to the docs root
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'WrightToolsdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'WrightTools.tex', 'WrightTools Documentation',
+     'WrightTools Developers', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'wrighttools', 'WrightTools Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'WrightTools', 'WrightTools Documentation',
+     author, 'WrightTools', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}


Test patch: