Project

General

Profile

Getting Started » History » Version 43

Vassilis Papavassiliou, 2012-12-04 03:32 PM

1 1 Prokopis Prokopidis
h1. Getting Started
2 2 Prokopis Prokopidis
3 2 Prokopis Prokopidis
Once you [[DeveloperSetup|build]] or [[HowToGet|download]] an ilsp-fc runnable jar, you can run it like this
4 2 Prokopis Prokopidis
5 11 Prokopis Prokopidis
<pre><code>java -jar ilsp-fc-1.1-jar-with-dependencies.jar</code></pre>
6 2 Prokopis Prokopidis
7 41 Prokopis Prokopidis
There are several settings that influence the crawling process and can be defined in a configuration file before the crawling process. The default configuration file is [[crawler_config.xml]] and is included in the ilsp-fc runnable jar. Two typical customized examples are [[FMC_config.xml]] for monolingual crawls and [[FBC_config.xml]] for bilingual crawls.
8 1 Prokopis Prokopidis
9 40 Prokopis Prokopidis
Some of the settings can also be overriden using options of the ilsp-fc runnable jar, as follows:
10 38 Prokopis Prokopidis
11 30 Vassilis Papavassiliou
<pre><code>-a :user agent name (required)
12 30 Vassilis Papavassiliou
-type : the type of crawling. Crawling for monolingual (m) or parallel (p).
13 38 Prokopis Prokopidis
-cfg : the configuration file that will be used instead of the default (see crawler_config.xml above). 
14 34 Vassilis Papavassiliou
-c : the crawl duration in minutes. Since the crawler runs in cycles (during which links stored at the top of 
15 34 Vassilis Papavassiliou
     the crawler’s frontier are extracted and new links are examined) it is very likely that the defined time
16 34 Vassilis Papavassiliou
     will expire during a cycle run. Then, the crawler will stop only after the end of the running cycle.
17 34 Vassilis Papavassiliou
     The default value is 10 minutes.
18 34 Vassilis Papavassiliou
-n : the crawl duration in cycles. The default is 1. It is proposed to use this parameter for testing purposes
19 34 Vassilis Papavassiliou
-t : the number of threads that will be used to fetch web pages in parallel.
20 34 Vassilis Papavassiliou
-f : forces the crawler to start a new job (required) 
21 34 Vassilis Papavassiliou
-lang : the targeted language in case of monolingual crawling (required).
22 34 Vassilis Papavassiliou
-l1 : the first targeted language in case of bilingual crawling (required).
23 34 Vassilis Papavassiliou
-l2 : the second targeted language in case of bilingual crawling (required).
24 28 Vassilis Papavassiliou
-u : the text file that contains the seed URLs that will initialize the crawler. In case of blingual crawling
25 28 Vassilis Papavassiliou
     the list should contain only 1 or 2 URLs from the same web doamin.  
26 1 Prokopis Prokopidis
-tc : domain definition
27 42 Vassilis Papavassiliou
-k : forces the crawler to annotate boilerplate content in parsed text.
28 42 Vassilis Papavassiliou
-filter : A regular expression to filter out URLs which do NOT match this regex.
29 42 Vassilis Papavassiliou
         The use of this filter forces the crawler to either focus on a specific 
30 42 Vassilis Papavassiliou
         web domain (i.e. ".*ec.europa.eu.*"), or on a part of a web domain 
31 42 Vassilis Papavassiliou
        (e.g.".*/legislation_summaries/environment.*"). Note that if this filter
32 42 Vassilis Papavassiliou
        is used, only the seed URLs that match this regex will be fetched.
33 37 Vassilis Papavassiliou
-d : forces the crawler to stay in a web site (i.e. starts from a web site and extracts only links to pages
34 37 Vassilis Papavassiliou
     inside the same web site). It should be used only for monolingual crawling.
35 22 Prokopis Prokopidis
</code></pre>
36 1 Prokopis Prokopidis
37 1 Prokopis Prokopidis
h2. Run a monolingual crawl
38 1 Prokopis Prokopidis
39 22 Prokopis Prokopidis
<pre><code>java -jar ilsp-fc-1.1-jar-with-dependencies.jar crawlandexport -a vpapa@ilsp.gr \
40 22 Prokopis Prokopidis
                -cfg FMC_config.xml -t 10 -type m -c 10 -lang de -of output_test1_list.txt \
41 22 Prokopis Prokopidis
                -ofh  output_test1_list.txt.html -tc Automotive-seed-terms-de.txt  \
42 22 Prokopis Prokopidis
                 -u  Automotive-seed-urls.txt -xslt -f -k</code></pre>
43 2 Prokopis Prokopidis
44 1 Prokopis Prokopidis
h2. Run a bilingual crawl
45 12 Vassilis Papavassiliou
46 29 Vassilis Papavassiliou
<pre><code>java -jar ilsp-fc-1.1-jar-with-dependencies.jar crawlandexport -a test1 -c 10 -f -k -l1 de -l2 it \
47 29 Vassilis Papavassiliou
                -t 10 -of test_HS_DE-IT_output.txt -ofh  test_HS_DE-IT_output.txt.html -tc HS_DE-IT_topic.txt \
48 29 Vassilis Papavassiliou
                -type p -xslt -u  seed_suva.txt -cfg FBC_config.xml</code></pre>
49 12 Vassilis Papavassiliou
50 2 Prokopis Prokopidis
51 2 Prokopis Prokopidis
h2. Example of java code
52 9 Prokopis Prokopidis
53 2 Prokopis Prokopidis
<pre>
54 2 Prokopis Prokopidis
<code class="java">
55 2 Prokopis Prokopidis
package gr.ilsp.fmc.classifier;
56 2 Prokopis Prokopidis
57 2 Prokopis Prokopidis
public enum ClassifierCounters {
58 2 Prokopis Prokopidis
    CLASSIFIER_DOCUMENTS_PASSED,   // successfully classified a document.
59 1 Prokopis Prokopidis
    CLASSIFIER_DOCUMENTS_FAILED,   // failed to classify a document
60 2 Prokopis Prokopidis
    CLASSIFIER_DOCUMENTS_ABORTED, 
61 2 Prokopis Prokopidis
    CLASSIFIER_TIME
62 8 Prokopis Prokopidis
}</code></pre>
63 2 Prokopis Prokopidis
64 2 Prokopis Prokopidis
<pre>
65 1 Prokopis Prokopidis
<code class="xml">
66 2 Prokopis Prokopidis
<?xml version="1.0" encoding="UTF-8"?>
67 2 Prokopis Prokopidis
<configuration>
68 2 Prokopis Prokopidis
        <agent>
69 2 Prokopis Prokopidis
                <email>yourmail@mail.com</email>
70 2 Prokopis Prokopidis
                <web_address>www.youraddress.com</web_address>
71 2 Prokopis Prokopidis
        </agent>
72 8 Prokopis Prokopidis
</configuration></code></pre>