Author: Jason Baldridge (email@example.com)
This is a parent repository for project related code for Applied NLP course being taught by Jason Baldridge at UT Austin. This involves creating applications that use Twitter streams and can take automated actions as Twitter users, using natural language processing and machine learning.
The name "tshrdlu" comes from Twitter+SHRDLU.
For more information, updates, etc., follow @appliednlp on Twitter. The @tshrdlu account is now doing some tweeting of its own (by which I mean automated tweeting, based on the code in this repository).
- Version 1.6 of the Java 2 SDK (http://java.sun.com)
Configuring your environment variables
The easiest thing to do is to set the environment variables
TSHRDLU_DIR to the relevant locations on your system. Set
to match the top level directory containing the Java installation you
want to use.
Next, add the directory
TSHRDLU_DIR/bin to your path. For example, you
can set the path in your
.bashrc file as follows:
Once you have taken care of these three things, you should be able to build and use tshrdlu.
You will also need to configure twitter4j Twitter access, see http://twitter4j.org/en/configuration.html for details.
If you plan to index and search objects using the provided code based
on Lucene, you can customize the directory where on-disk indexes are
stored (the default is the tempdir, check the directory
setting the environment variable
Some functionality depends on GeoNames API access
(free to sign up and use). To take advantage of this functionality, create an
account and set the environment variable
TSHRDLU_GEONAMES_USERNAME to your
GeoNames username. tshrdlu should still run without this but some of the
repliers will not function.
Building the system from source
tshrdlu uses SBT (Simple Build Tool) with a standard directory
structure. To build tshrdlu, type (in the
$ ./build update compile
This will compile the source files and put them in
./target/classes. If this is your first time running it, you will see
messages about Scala being downloaded -- this is fine and
expected. Once that is over, the tshrdlu code will be compiled.
To try out other build targets, do:
This will drop you into the SBT interface. To see the actions that are possible, hit the TAB key. (In general, you can do auto-completion on any command prefix in SBT, hurrah!)
To make sure all the tests pass, do:
$ ./build test
Documentation for SBT is at http://www.scala-sbt.org/
Note: if you have SBT already installed on your system, you can
also just call it directly with "sbt" in
Questions or suggestions?
Email Jason Baldridge: firstname.lastname@example.org
Or, create an issue: https://github.com/utcompling/tshrdlu/issues