Skip to content

meyersbs/SPLAT

Repository files navigation

Build Status License codecov PyPI PyPI Website



Contact Information

    Benjamin S. Meyers <ben@splat-library.org>


Project Description

SPLAT is a command-line application designed to make it easy for linguists (both computer-oriented and non-computer-oriented) to use the Natural Language Tool Kit (NLTK) for analyzing virtually any text file.

SPLAT is designed to help you gather linguistic features from text files and it is assumed that most input files will not be already annotated. In order for SPLAT to function properly, you should ensure that the input files that you provide do not contain any annotations. Because there are so many variations of linguistic annotation schemes, it would simply be impossible to account for all of them in the initial parsing of input files; it is easier for you to remove any existing annotations than it is for me to do so.


System Requirements

SPLAT is being developed and tested on 64-bit Ubuntu 15.10 with Python 3.4.3. Minimum requirements include:

  • Python 3.4 or Later
  • NLTK 3.1 or Later
  • Java (for the Berkeley Parser)
  • NLTK packages brown, stopwords, names, and cmudict

Installation

  1. Ensure that Python3.4 (or newer) is installed on your machine.
  2. Run the following in a command line:
    pip3 install SPLAT-library

To uninstall run the following in a command line.

    pip3 uninstall SPLAT-library

General Commands

    splat --commands                # List all available commands
    splat --help                    # Provide helpful information
    splat --info                    # Display version and copyright information
    splat --usage                   # Display basic command line structure
    splat splat filename            # Display the raw text from the file

Functionality & Usage

Coming Soon!


Acknowledgments

See Acknowledgments.


Licensing

See LICENSE.md.