Commit b16aff89 authored by Maximilian Dolling's avatar Maximilian Dolling

rtfm

parent 13494e81
This diff is collapsed.
......@@ -5,16 +5,21 @@ It generates a set of plots focusing on aspects such as time humans spent in spa
## Install
The script requires Python >= 3.6.1 and uses the libraries [pandas](https://pandas.pydata.org/) as well as [matplotlib](https://matplotlib.org/).
The script comes with a predefined Python environment, which is managed by [pipenv](https://github.com/pypa/pipenv).
The environment handles all dependencies.
> The script has been successfully tested on Windows 10 with Python 3.6.10.
> The script has been successfully tested on 5.7.8-arch1-1 with Python 3.8.3
Please clone this repository and install the [required dependencies](requirements.txt) as follows:
Please clone this repository and install the [environment and the dependencies](Pipfile) as follows:
```bash
# in case you do not have installed pipenv
pip install pipenv
```
```bash
git clone ...
cd astronaut-analysis
pip install -r requirements.txt
pipenv install
```
## Usage
......@@ -22,7 +27,7 @@ pip install -r requirements.txt
You can run the script as follows:
```bash
python astronaut-analysis.py
pipenv run python src/astronaut-analysis.py
```
The script processes the [astronauts data set]( data/astronauts.json) and stores the plots in the directory `results`.
......
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