-
Notifications
You must be signed in to change notification settings - Fork 8
Command Line Interface
- You must also have EXSCLAIM installed.
To use the CLI, open a command line interpreter (bash, zsh, Windows PowerShell, etc). You can use the following commands:
- exsclaim run
- exsclaim view
- exsclaim test
- exsclaim train
Use this command to run the exsclaim pipeline. To run, type in:
$ exsclaim run /path/to/query.json [-t]
Where /path/to/query.json is the path (absolute or relative) to a Query JSON file. -t is an optional flag for specify which tools to include in the pipeline. Omitting -t includes all tools (JournalScraper, CaptionDistributor, and FigureSeparator). Otherwise, include the first letter of each tool you wish to use. This is order and case insensitive. For example, if you want to use the JournalScraper and FigureSeparator:
$ exsclaim run query.json -t jf
is equivalent to:
$ exsclaim run query.json -t Fj
Use this command to run the User Interface. Optional flags include:
- configuration (-c): Path to an INI configuration file, containing username and password for database
- bind (-b): If included, will make supplied configuration file the new default configuration file
- initialize (-i): If included, will try to create database and user included in configuration file
For the first time running on an installation of exsclaim, you should use:
$ exsclaim view -c /path/to/configuration.ini -bi
and for successive runs:
$ exsclaim view
To test exsclaim, try:
$ exsclaim test
This will run a few simple tests. If the last test fails, your installation may still be correct. This test compares a resulting exsclaim.json against a reference and minor differences (between floats, OS specific paths, or spacy version specific caption predictions) are okay.