VARAT: Variable Annotation Tool for Engineering-domain Documents

System requirements

• Python 3 (3.9 or later except for 3.9.7)
  • because streamlit (1.15.2) requires Python >=3.7, !=3.9.7
• Preferred: A Web Browser with MathML support
  • Firefox is recommended.

Installation

The dependencies related to python library will be installed with one shot using Poetry:

poetry install --no-dev

You can also use pip and requirements.txt.

python -m pip install -r requirements.txt

In case you don't want to install the dependencies into your system, you should consider utilizing a virtual environment, such as venv or pyenv-virtualenv.

The TeX files are used as the input document for this tool. LaTeXML is required to use this tool.

Usage

streamlit run streamlit_annotation.py

Files in this repository

• lib/ contains the project library.
• tools/ contains our utility Python scripts.

All of the annotation data is not included in this repository due to several constraints.

• data/Anno contains folders whose names are processes' names.
• data/Anno/[Process name] contains folders whose names indicate papers' authors and publication year.
  • Each folder contains the original documents (.tex), the annotation data (.xlsx), and the preprocessed docuemnts (.html and .txt). The tex files were manually created to reproduce the papers in PDF format.
  • doi_list.csv lists the authors, titles and DOIs of the papers used for annotation.

License

Copyright 2023 Shota KATO

This software is licenced under the MIT license.