Metadata-Version: 1.1
Name: topicexplorer
Version: 1.0b80
Summary: InPhO Topic Explorer
Home-page: http://inphodata.cogs.indiana.edu
Author: The Indiana Philosophy Ontology (InPhO) Project
Author-email: inpho@indiana.edu
License: UNKNOWN
Download-URL: http://github.com/inpho/topic-explorer
Description: InPhO Topic Explorer
        ====================
        
        |Travis| |GitHub license| |PyPI|
        
        This interactive visualization displays information from the LDA topic
        models generated using the `InPhO VSM
        module <http://github.com/inpho/vsm/>`__. Live demos trained on the
        Stanford Encyclopedia of Philosophy, a selection of books from the
        HathiTrust Digital Library, and the original LDA training set of
        Associated Press articles are available at
        `http://inphodata.cogs.indiana.edu <http://inphodata.cogs.indiana.edu/>`__.
        
        The color bands within each article's row show the topic distribution
        within that article, and the relative sizes of each band indicates the
        weight of that topic in the article. The total width of each row
        indicates similarity to the focal topic or document, measured by the
        quantity sim(doc) = 1 – JSD(doc, focus entity), where JSD is the
        Jensen-Shannon distance between the word probability distributions of
        each item. Each topic's label and color is arbitrarily assigned, but is
        consistent across articles in the browser.
        
        Display options include topic normalization, alphabetical sort and topic
        sort. By normalizing topics, the combined width of each bar expands so
        that topic weights per document can be compared. By clicking a topic,
        the documents will reorder acoording to that topic's weight and topic
        bars will reorder according to the topic weights in the highest weighted
        document. When a topic is selected, clicking "Top Documents for [Topic]"
        will take you to a new page showing the most similar documents to that
        topic's word distribution. The original sort order can be restored with
        the "Reset Topic Sort" button.
        
        Installation
        ------------
        
        There are two types of install: Default and Developer.
        
        Default Install
        ~~~~~~~~~~~~~~~
        
        1. Install the `Anaconda Python 2.7
           Distribution <http://continuum.io/downloads>`__.
        2. Open a terminal and run ``pip install --pre topicexplorer``.
        3. Test installation by typing ``vsm -h`` to print usage instructions.
        
        Developer Install
        ~~~~~~~~~~~~~~~~~
        
        1. `Set up Git <https://help.github.com/articles/set-up-git/>`__
        2. Install the `Anaconda Python 2.7
           Distribution <http://continuum.io/downloads>`__.
        3. Open a terminal and run
           ``pip install --src . -e git+https://github.com/inpho/topic-explorer#egg=topicexplorer``
        4. Test installation by typing ``vsm -h`` to print usage instructions.
        
        Usage
        -----
        
        .. figure:: http://inphodata.cogs.indiana.edu/img/workflow.png
           :alt: Workflow
        
           Workflow
        
        1. Initialize the Topic Explorer on a file, folder of text files, or
           folder of folders:
        
           ::
        
               vsm init PATH [CONFIG]
        
           This will generate a configuration file called *CONFIG*.
        
        2. Train LDA models using the on-screen instructions:
        
           ::
        
               vsm train CONFIG
        
        3. Launch the topic explorer:
        
           ::
        
               vsm launch CONFIG
        
        4. Press Ctrl+C to quit all servers.
        
        See the sample configuration files in the ``config`` directory for
        examples of how to extend the topic explorer.
        
        Bug Reports
        -----------
        
        Please report issues on the `issue
        tracker <http://github.com/inpho/topic-explorer/issues>`__ or contact
        Jaimie directly (contact info at bottom of README).
        
        In your report, please include the error message, the command you ran,
        your operating system, and the output of the command ``vsm --version``.
        This will ensure that we can quickly diagnose your issue.
        
        **Note:** When using a developer install ``vsm --version`` will print in
        the following format: ``1.0b39-1-g7c834bf-dirty``. \* The first part is
        the most recent release tag. (``1.0b39``) \* The second part is the
        number of commits since the tag. (``1``) \* The next is the hash of the
        most recent commit. (``g7c834bf``) \* The optional ``-dirty`` flag
        indicates that the local repository has uncommitted changes.
        
        Alternate Installs
        ------------------
        
        We highly recommend using the Anaconda Python 2.7 Distribution.
        Straightforward instructions are provided above for Anaconda Python 2.7
        for both end users and developers. Both of these installs are officially
        supported.
        
        Below we offer guidance for installing side-by-side with an Anaconda
        Python 3.5 install or for installing it without Anaconda, with notes on
        dependencies.
        
        Python 3 Install
        ~~~~~~~~~~~~~~~~
        
        The InPhO Topic Explorer is **only** compatible with Python 2.7.
        However, Anaconda for Python 3.5 makes it easy to set up a side-by-side
        install of Python 2.7 so you can use both Python 3.5 and Python 2.7.
        
        1. Install the `Anaconda Python 3.5
           Distribution <http://continuum.io/downloads>`__.
        2. Open a terminal and run ``conda create -n py27 python=2.7 anaconda``.
           This will create a Python 2.7 Anaconda environment.
        3. Run ``source activate py27`` to activate the Python 2.7 bindings. You
           should see ``(py27)`` before your prompt.
        4. Use either the Default or Developer `install
           instructions <#installation>`__, skipping the step to install
           Anaconda Python 2.7.
        5. Run ``source deactivate`` to deactivate Python 2.7 bindings and
           reactivate Python 3.5 bindings. Note that the ``vsm`` command will
           only work when the Python 2.7 bindings are activated.
        
        Non-Anaconda Install
        ~~~~~~~~~~~~~~~~~~~~
        
        -  **Miniconda**
        
        1. If using Miniconda (a small version of Anaconda), the necessary
           packages are:
           ``conda install numpy scipy nltk matplotplib ipython networkx``
        
        -  **Debian/Ubuntu**
        
        1. ``sudo apt-get-install build-essential python-dev python-pip python-numpy python-matplotlib python-scipy python-ipython``
        
        2. `IPython Notebooks <http://ipython.org/install.html>`__
        
        -  **Windows**
        
        1. Install `Microsoft Visual C++ Compiler for Python
           2.7 <http://www.microsoft.com/en-us/download/details.aspx?id=44266>`__
        
        2. Install the Python packages below:
        
           -  `Numpy <http://sourceforge.net/projects/numpy/files/NumPy/>`__
           -  `Scipy <http://sourceforge.net/projects/scipy/files/scipy/>`__
           -  `matplotlib <http://matplotlib.org/downloads.html>`__
           -  `IPython Notebooks <http://ipython.org/install.html>`__
        
        Licensing and Attribution
        -------------------------
        
        The project is released under an `Open-Source Initiative-approved MIT
        License <http://opensource.org/licenses/MIT>`__.
        
        The InPhO Topic Explorer may be cited as:
        
        -  Jaimie Murdock and Colin Allen. (2015) *Visualization Techniques for
           Topic Model Checking* in Proceedings of the 29th AAAI Conference on
           Artificial Intelligence (AAAI-15). Austin, Texas, USA, January 25-29,
           2015. http://inphodata.cogs.indiana.edu/
        
        A `BibTeX
        file <https://github.com/inpho/topic-explorer/blob/master/citation.bib>`__
        is included in the repository for easier attribution.
        
        Collaboration and Maintenance
        -----------------------------
        
        The InPhO Topic Explorer is maintained by `Jaimie
        Murdock <http://jamram.net/>`__:
        
        -  E-mail: jammurdo@indiana.edu
        -  Twitter: [@JaimieMurdock](http://twitter.com/JaimieMurdock)
        -  GitHub: [@JaimieMurdock](http://github.com/JaimieMurdock)
        -  Homepage: http://jamram.net/
        
        Please report issues on the `issue
        tracker <http://github.com/inpho/topic-explorer/issues>`__ or contact
        Jaimie directly.
        
        We are open to collaboration! If there's a feature you'd like to see
        implemented, please contact us and we can lend advice and technical
        assistance.
        
        .. |Travis| image:: https://img.shields.io/travis/inpho/topic-explorer.svg
           :target: https://travis-ci.org/inpho/topic-explorer
        .. |GitHub license| image:: https://img.shields.io/badge/license-MIT-blue.svg
           :target: https://github.com/inpho/topic-explorer/blob/master/LICENSE.txt
        .. |PyPI| image:: https://img.shields.io/pypi/v/topicexplorer.svg
           :target: https://pypi.python.org/pypi/topicexplorer
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Bottle
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: Text Processing :: Linguistic
