change README

This commit is contained in:
sporada 2021-01-19 15:36:07 +01:00
parent b2857312c5
commit 24774613c2

View File

@ -1,13 +1,13 @@
# What is this? # What is this?
This django web app is part of a masterthesis. Said thesis can be read [here](https://gitlab.ub.uni-bielefeld.de/sporada/bundesdata_web_app/raw/24641c2959796659d428514c9cdd3782d4248da0/2019-02-04_Stephan_Porada_Masterthesis_semi.pdf?inline=false). This django web app is part of a masterthesis. Said thesis can be read [here](https://gitea.sporada.eu/sporada/bundesdata_web_app/src/branch/master/2019-02-04_Stephan_Porada_Masterthesis_semi.pdf).
The app displays the session protocols of the german Bundestag from 1949 till 2017. The app displays the session protocols of the german Bundestag from 1949 till 2017.
Besides that the app provides an Ngram Viewer that displays word frequencies over time for all those protocols. Th Ngram Viewer and its functionality is similar to the [Google Ngram Viewer](https://books.google.com/ngrams). Besides that the app provides an Ngram Viewer that displays word frequencies over time for all those protocols. The Ngram Viewer and its functionality is similar to the [Google Ngram Viewer](https://books.google.com/ngrams).
The n-gram data and the protocols have been created using this software (also part of the same masterthesis): https://gitlab.ub.uni-bielefeld.de/sporada/bundesdata_markup_nlp_software The n-gram data and the protocols have been created using this software (also part of the same masterthesis): hthttps://gitea.sporada.eu/sporada/bundesdata_markup_nlp_software
The actual data can be found here: https://gitlab.ub.uni-bielefeld.de/sporada/bundesdata_markup_nlp_data The actual input and output data can be found here: https://gitea.sporada.eu/sporada/bundesdata_markup_nlp_data
## Live Version ## Live Version
@ -41,7 +41,7 @@ A live version of the Web app with the above mentioned data can be visited here:
2. Change the owner rights of all files in the repository. (This step should only be necessary for linux systems.) 2. Change the owner rights of all files in the repository. (This step should only be necessary for linux systems.)
- This has to be done because every process inside a docker container is always executed with root privilage. Thus the created volumes are not accessable anymore. - This has to be done because every process inside a docker container is always executed with root privilage. Thus the created volumes are not accessable anymore.
- Change the rights with `sudo chown -R $USER:$USER .`. - Change the rights with `sudo chown -R $USER:$USER .`.
3. Download the folders *MdB\_data* and *outputs* from the link mentioned in [this repository](https://gitlab.ub.uni-bielefeld.de/sporada/bundesdata_markup_nlp_data). 3. Download the folders *MdB\_data* and *outputs* from the link mentioned in [this repository](https://gitea.sporada.eu/sporada/bundesdata_markup_nlp_data).
- Copy those into the folder *input_volume* which is located inside the web app repository on the root level. - Copy those into the folder *input_volume* which is located inside the web app repository on the root level.
- If the downloaded folders are inside an archive extract the folders first. - If the downloaded folders are inside an archive extract the folders first.
- The folder *input_volume* is a volume which is mounted into the web app container. The contianer is able to read every data inside that volume. Note that the volume is accessed with the path */usr/src/app/input_data* not */usr/src/app/input_volume*. - The folder *input_volume* is a volume which is mounted into the web app container. The contianer is able to read every data inside that volume. Note that the volume is accessed with the path */usr/src/app/input_data* not */usr/src/app/input_volume*.