/Clippy

Primary LanguageTypeScript

You Tube Link of Clippy

  • https://youtu.be/gEyYHD3tCuk
  • Project Title

    Clippy: Smart PDF Reader for better Paper Reading Experience and Knowledge Mining

    Project Description

    1.1. Authentication

    There are two different types of user modes in our system - Guest and authenticated user. A user needs to provide a full name, email, password, institution and
    designation to register to the system. A 6 digit OTP will be sent to email for verification. Users can log in with email and password. After a successful login users
    can access tools that allow him or her to maintain track of previously read research publications.

    1.2. Searching a Paper

    A user can search paper in two ways: By uploading the PDF manually or by searching by the Paper Title. If a user searches using the paper title,
    a list of related papers will be displayed. Among the displayed papers, users can select a paper.
    After selection of the paper, they will get three options: Cross Referencing of Objects Summarization of PDF Generating a knowledge Graph

    1.3. Cross Referencing of Objects

    A PDF usually contains a number of figures, tables, charts etc. It references other papers as well. For efficient and easy PDF reading,
    Clippy supports cross referencing of the objects. Clippy works in two modes: Automatic cross referencing mode
    and manual cross referencing mode
    . When automatic cross referencing is called , the referenced objects will be shown in a popup overlay whenever the reader hovers over the reference keyword annotation
    In manual cross referencing mode, when a user hovers over a keyword of figure and table,
    a pop over window will be displayed containing the cropped window of a
    particulur images or tables.

    1.4. Building a knowledge graph

    A research paper usually references other papers. The referenced papers may have citations among themselves too.
    Clippy will generate a knowledge graph showing the citations within the paper, also the interrelation among the cited papers too.
    A user will be able to determine the sequence of study for research articles with the aid of the knowledge graph.

    1.5. Summary of Important Elements

    A research paper's essential components include an abstract, background information,
    references, methodology, experiment baselines, and result analysis. Summarizing the important elements may help a reader in grabbing the quicker understanding of the paper.
    Clippy comes with two types of summarization: extractive and abstractive . Clippy will highlight the important sentences from the paper if extractive summary is selected.
    A summary from each block of the paper ie. abstract, background study etc. and TLDR will be shown as a distinct PDF if the abstractive summary is selected. All the summary generated by Clippy can be exported as PDF.

    Prerequisites

    • Node.js
    • MongoDB
    • Angular
    • Express.js

    Scopes and Limitations

    1. For extractive summarizing, we used the free version of the meaning cloud api, and for abstractive summary, we used the one ai api. That is why,we are now only allowed to use the api 20,000 times per month.
    2. File organization should follow a consistent format. If not, it's likely that the pdf.js library won't be able to locate text chunks correctly. Note that pdf.js is a prerequisite for this project.
    3. Citation graph will not be shown if the software can not find the paper in semantic scholar.

    Installation

    1. Clone the repository:
    2. git clone https://github.com/jaf107/Clippy.git
    3. Install the dependencies:
    4. cd frontend
      npm install --save
    5. Start the application:
      • If angular cli is installed globally:
      • ng serve
      • If not then:
      • npm start
    6. Open a web browser and go to http://localhost:4200
    7. Install the dependencies:
    8. npm install
    9. Start the backend
    10. cd server
      npm start

      Contributors

    • Md Siam bsse1104@iit.du.ac.bd University of Dhaka
    • Abu Jafar Saifullah bsse1109@iit.du.ac.bd University of Dhaka
    • Kazi Muktadir Ahmed bsse1111@iit.du.ac.bd University of Dhaka
    • Mustahid Hasan bsse1114@iit.du.ac.bd University of Dhaka
    • Jitesh Sureka bsse1115@iit.du.ac.bd University of Dhaka
    • Tasmia Zerin bsse1128@iit.du.ac.bd University of Dhaka