Installing PeARS

Setting up the PeARS environment

The best way to get acquainted with the current state of the project is to install the development version. Please follow the instructions here to set things up

Click to expand Instruction set

  1. 1. Clone PeARS repo

    git clone https://github.com/PeARSearch/PeARS-orchard.git
    cd PeARS-orchard
  2. 2. Setting up the environment

    1. 2.1. Set up virtualenv

      We recommend using virtualenv for the development. If you are just here for test it out, skip to the next section.

      Install pip3
      sudo apt update
      sudo apt install python3-setuptools
      sudo apt install python3-pip

      (or some other way your distribution supports).

      Install virtualenv using pip
      sudo pip3 install virtualenv
      Create a new virtualenv for PeARS and activate it
      virtualenv -p python3 env && source env/bin/activate
    2. 2.2. Install the build dependencies

      We recommend using pip for installation. In case you don't have this, look inside requirements.txt and install dependencies manually.

      pip3 install -r requirements.txt
  3. 3. Running the PeARS search engine

    In the root directory of the repo, run

    python3 run.py

    Go to the browser and type localhost:8080. You should find PeARS running there. You don't have any pages indexed yet, so go to the F.A.Q. page (link at the top of the page) and follow the short instructions to get you going!

Do let us know is anything isn't working for you by opening an issue on the GitHub page!