Skip to content

Commit b82de66

Browse files
authored
Merge pull request #59 from HMEUW/newbie
docs: Update README for Windows instructions and Python example notebook
2 parents a36d755 + bbc96d1 commit b82de66

3 files changed

Lines changed: 322 additions & 120 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,23 @@ pip install -r requirements.txt
4343
pip install -e .
4444
```
4545

46+
Example using `conda`and `pip` to install the dependencies in a new environment env on Windows, using Anaconda Prompt. First you clone the GeoProfile repository to a local folder (c:\my_python_files\geoprofile) and change directory towards it. You will create an empty conda enviroment with python 3.12 and activate it. Python 3.12 is given in `requirements.txt`. The name of the environment is not `env`, as in Linux example above, because the name `env` has a special property in conda. You will update pip. Install dependencies.
47+
48+
Last three lines are optional. Installation of `ipykernel` allows to run a notebook in this environment. To save figures in the notebook example: install `kaleido` and update `plotly`.
49+
50+
```bash
51+
git clone https://github.com/cemsbv/GeoProfile.git c:\my_python_files\geoprofile
52+
cd c:\my_python_files\geoprofile
53+
conda create --name env_geoprofile --no-default-packages python=3.12
54+
conda activate env_geoprofile
55+
python -m pip install --upgrade pip setuptools
56+
pip install -r requirements.txt
57+
pip install -e .
58+
conda install ipykernel
59+
pip install -U kaleido==1.2.0
60+
pip install plotly==6.1.1
61+
```
62+
4663
## Documentation
4764

4865
Build the docs:

notebook/Nxxxxx.py

Lines changed: 0 additions & 120 deletions
This file was deleted.

notebook/basis_example.ipynb

Lines changed: 305 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)