Commit c43289ac authored by Michael Rudolf's avatar Michael Rudolf

Added requirements already shipped with last commit.

parent 4232ca3c
......@@ -20,4 +20,7 @@ All relevant scripts are located in the [src](https://gitext.gfz-potsdam.de/anal
The other modules contain helper functions for easy file handling and saving the current stage of processing etc.
## Documentation
Because most of the work is outsourced into modules the two 'master' scripts and the comments inside them should provide enough documentation to assess the project pipeline. A more in-depth documentation of what the functions do including more comments on the source code is given in the form of jupyter notebooks in [Notebooks](https://gitext.gfz-potsdam.de/analab-code/shear-madness/tree/master/notebooks). Because GitLabs supports the display of jupyter notebooks very well they can be viewed online like a normal documentation. If you want to follow the individual steps and actually run the jupyter notebooks you have to make sure to install [↪jupyter (external link!)](https://jupyter.org) on your machine and run a jupyter notebook server. In some cases you need to place them into the src folder to properly pick up the modules. They are not required to run the main scripts.
Because most of the work is outsourced into modules the two 'master' scripts and the comments inside them should provide enough documentation to assess the project pipeline. A more in-depth documentation of what the functions do including more comments on the source code is given in the form of jupyter notebooks in [Notebooks](https://gitext.gfz-potsdam.de/analab-code/shear-madness/tree/master/notebooks). Because GitLabs supports the display of jupyter notebooks very well they can be viewed online like a normal documentation. If you want to follow the individual steps and actually run the jupyter notebooks you have to make sure to install [jupyter (external link!)](https://jupyter.org) on your machine and run a jupyter notebook server. In some cases you need to place them into the src folder to properly pick up the modules. They are not required to run the main scripts.
## Requirements
The scripts require [Python 3(external link!)](https://python.org) to run. The required external libraries can be found in [requirements.txt](https://gitext.gfz-potsdam.de/analab-code/shear-madness/blob/master/requirements.txt). If not noted otherwise the most recent version of each module or python at the time of the commit is used. Older versions might work but remain untested.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment