Skip to content

Getting Started

Jump to bottom
Tris edited this page Apr 5, 2019 · 4 revisions

Setting up the program

To run the Athena server software you need the following dependencies installed, configured and running:

  • Java, version 8
  • MariaDB, version >= 10

The server software may work with other Java versions but it is highly recommended to use Java version 8. For MySQL you need MariaDB with version 10 or greater running. MariaDB is included in the default repositories of most Linux distributions and available on other platforms, too. Most Linux distributions provide a documentation with all basic setup steps for MariaDB. Check the internet for your distribution.

Make sure the daemon is running. It needs a configured user with full rights for an own database. The default user and database name is 'athena'. The default value for the password can be found in the 'src/resources/METAINF/persistence.xml'-file. You should change this password for extended public runtime of the server.

Build the server jar file with Maven and move it to any location you like. For easier start/stop convention you can use the 'src/scripts/athena.sh'-script to start and stop the server. Copy the script into the folder where your server jar lies. Documentation of How-To-Use can be found within the script-file.

Commandline Arguments

The following list contains arguments that can be given to the jar file when starting it via the command line (e.g. java -jar MyAwesomeJar.jar -foo=bar -baz). They can be provided in any order. If you do not provide any arguments, only the API service will start.

  • -scrape-paper-author Provide this argument to tell the program that you want to gather paper and author information from the ACL website
  • -scrape-acl18-info Provide this argument to tell the program that you want to save information about the ACL 2018 conference (this includes, among other things, the conference's name, location, and schedule)
  • -beginYear=<year> Substitute <year> with the first year (inclusive) of which you want to store paper and author information from the ACL website. This argument has no effect without -scrape-paper-author. If this argument is not provided, the defaut will be 2018.
  • -endYear=<year> Substitute <year> with the last year (inclusive) of which you want to store paper and author information from the ACL website. This argument has no effect without -scrape-paper-author. If this argument is not provided, the defaut will be 2018.
  • -conferences=<conferenceList> Substitute <conferenceList> with a comma separated list of conference abbreviations (found on https://aclanthology.info/). Any conference contained in this list will have its papers and authors saved into the database. Any conference not in the list will not have its papers and authors saved. If you don't provide this argument, all papers and authors of all conferences listed on the page above will be included. Example: -conferences=ACL,TACL,NACL

If you want to run the program with -scrape-acl18-info, you have to run it with -scrape-paper-author and include the year 2018 as well due to the former relying on data from the latter.

Clone this wiki locally