Skip to content

Commit

Permalink
Formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
johnb30 committed Oct 31, 2016
1 parent 7139eba commit 94b528f
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@ A Python Engine for Text Resolution And Related Coding Hierarchy.


One of my students put it this way: "Francesco Petrarch was Kayne West. He jumps up on stage, says
'Yo, welcome to the Renaissance, bitches!' And then drops the mike." <br\>
Dorsey Armstrong <br\>
'Yo, welcome to the Renaissance, bitches!' And then drops the mike."

Dorsey Armstrong

*Great Minds of the Medieval World* (Great Courses Series), lecture 20

PETRARCH is a natural language processing tool for machine-coding events data.
Expand Down Expand Up @@ -90,13 +92,25 @@ If not installed:

``python petrarch.py batch -i <INPUT FILE> -o <OUTPUT FILE>``

You can see a sample of the input/output by running (assuming you're in the
PETRARCH2 directory):

``petrarch2 batch -i ./petrarch2/data/text/GigaWord.sample.PETR.xml -o
test.txt``

This will return a file named `evts.test.txt`.

There's also the option to specify a configuration file using the ``-c <CONFIG
FILE>`` flag, but the program will default to using ``PETR_config.ini``.

When you run the program, a ``PETRARCH.log`` file will be opened in the current
working directory. This file will contain general information, e.g., which
files are being opened, and error messages.

But seriously, you should probably use
[hypnos](https://github.com/caerusassociates/hypnos) rather than run PETRARCH
as a standalone program.

Logged Warnings
---------------

Expand Down

0 comments on commit 94b528f

Please sign in to comment.