Commit ce2e9c75 authored by Martin Schrön's avatar Martin Schrön
Browse files

Readme update

parent 18bc8a8b
......@@ -49,7 +49,7 @@ Demonstration for a CRNS rover dataset (works similar for CRNS station data):
Here is a suggestion of how Corny could be installed. It has not been tested *everywhere*, so please contribute to this list if it also works (or doesn't) on your system :-)
### Download
### 1. Download Corny
You can download the [latest version as a zip file](https://git.ufz.de/CRNS/cornish_pasdy/-/archive/master/cornish_pasdy-master.zip). Extract the archive and Corny is ready to go.
......@@ -57,7 +57,7 @@ Alternatively, you can use *Git* (optional, but recommended). Git is a handy ver
git clone https://git.ufz.de/CRNS/cornish_pasdy.git
### Python 3.*
### 2. Install Python
First, get Python, e.g., from here: [Python.org](https://www.python.org/downloads/).
It is important that your system knows where Python has been installed. So on the python install dialogue, check "Add Python to PATH" and "Disable path length limit". Or manually edit your system-specific environmental variables.
......@@ -74,7 +74,7 @@ Does not seem to work on:
- Anaconda distribtion
- version 3.6 (installation issues with package `osmnx`)
### Use Virtual Environments (optional)
#### 2.1 Use Virtual Environments (optional)
The concept of virtual environments protects your other python projects from interfering package versions and dependency clashes. **If you are a python developer** and want to keep your packages safe from Corny dependencies, use this option.
......@@ -89,9 +89,9 @@ Now you can install packages and mess around without disturbing your other pytho
If the execution fails on Windows, it's probably a line-ending error. Edit the file `env/Scripts/activate` and change line endings to `LF` (Unix).
To deactivate the session, just type `deactivate`.
### Package installation
### 3. Package installation
#### Linux
#### 3.1 Linux
You have two options:
......@@ -112,7 +112,7 @@ You have two options:
To continue the installation of `kivy garden`, please follow item 4 in the next section.
#### Windows
#### 3.2 Windows
Windows has problems with the automatic installation of GDAL and other packages. That's why we split the installation into two parts:
......@@ -141,7 +141,7 @@ Windows has problems with the automatic installation of GDAL and other packages.
Test the installation by running `python cornyApp.py`. Let us know whether you come over any issues.
### Jupyter Lab (optional)
### 3.3 Jupyter Lab (optional)
[Jupyter notebooks](https://jupyter.org/) are a great way to play with python, here is a short instruction of installation:
......
Supports Markdown
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