This repository contains a list of loosely connected tools used in the academic environment.
The repository currently consists of the following elements:
- src : folder containing scripts, mostly Jupyter notebooks for demonstration purposes
- data : folder containing data, mostly mocked for demonstration purposes
The following tools are currently available:
- bibfile-overlap: a tool detecting overlapping identifiers and titles of references in a bibliography file (
.bib) as typically used in scientific publications written in LaTeX. - search-string-construction: a tool generating a search string from a list of concepts, a matrix of synonyms, and a list of relevant search fields. The search string can be used in academic databases for a systematic search.
- dockerization: an exemplary repository demonstrating a simple use of Docker and docker-compose to start a RESTful API realized with
fastAPI. More importantly, it demonstates how the file-structure should look like in case the main file (service.py) references helper files in subordinate folders (helper.py). - thunderpython: a simple routine to start the Thunderbird email client and prepare a mail to a target. This can be used for mail series.
Additional information regarding purpose and use of specific tools can be found below.
The dockerization folder can be used to explore the proper use of docker and docker-compose to get a simple API running. There are two ways of starting the container:
- Via Docker directly:
- build the image with
docker build . -t <name>:<tag> -p 8080:8000 - start the container with
docker run -it <name>(append theshattribute to enter the docker shell instead of executing the command) - Via Docker-compose:
- build the image with
docker-compose build - start the container with
docker-compose run
Once the docker container is running, you can access the service at localhost:8080/health