Skip to content

Latest commit

 

History

History
110 lines (80 loc) · 4.46 KB

README.rst

File metadata and controls

110 lines (80 loc) · 4.46 KB
Raw

uqlab-citations

Project to keep track of the external citations of UQLab. External citations of UQLab exclude publications made by the current members of the Chair of Risk, Safety and Uncertainty Quantification and only include works that explicitly used UQLab, not merely citing it.

The project contains command line utilities to convert the list of citations stored in a BibTeX file into an HTML page (as shown in the UQLab publications page or a short PDF report with some numbers and figures.

Requirements

uq_citations was developed and tested using Anaconda Python distribution (). Additional required packages are:

  • bibtexparser for parsing BibTeX file
  • python-dateutil for treatment of date
  • jinja2 for templating

A configuration file to recreate the environment used during the development is available in environment.yml. To recreate the environment:

conda env create -f environment.yml

Installation

Use the package manager pip to install the python package uq_citations from the cloned source directory:

pip install

or for editable mode:

pip install -e .

Successful installation will make the following command line utilities available in the path:

  • uq_citations_bibtex2html
  • uq_citations_bibtex2pdf

BibTeX2HTML

The command line utility uq_citations_bibtex2html is used to create a list of citations as an HTML page. The utility requires the following:

  • the BibTeX file (containing only the UQLab external citations)
  • the html list template file (included as ./templates/bib_list.html)
  • the html page template file (included as ./templates/html_tpl.html), this also includes the style for HTML elements.

To show the help of the utility, type:

uq_citations_bibtex2html --help

Additional Notes

Google Scholar

Google Scholar is used to track the UQLab citation.

BibTeX file

The full list of UQLab external citations is stored in a BibTeX file. The file contains only citations that explicitly mentioned that UQLab has been used in the work. Therefore, this excludes works that merely mention UQLab.

The file uqlab-citations.bib inside the folder ./bib contains the latest list of UQLab external citations.

Main subjects Subjects
Life Sciences
  • Biology
  • Biomedical sciences
Computational Science and Engineering N/A
Engineering Applications
  • Chemical engineering
  • Civil engineering
  • Electrical engineering
  • Energy engineering
  • Mechanical engineering
  • Monitoring and remote sensing
  • Nuclear engineering
  • Ocean engineering
Geosciences and Environmental Engineering
  • Geoscience
  • Geology
  • geomechanics
  • Environmental engineering

The keywords field of each BibTeX entry, with the exception of the Computational Science and Engineering*, must contain at most 1 of the subject listed in the Subject column above.

Due to the currently limited number of citations, the subject Material science and engineering should be assigned Mechanical engineering as its subject.