|
12 | 12 |
|
13 | 13 | ## Setup local developer environment
|
14 | 14 |
|
15 |
| -- download and install Anaconda 64 bit from [anaconda.com](https://www.anaconda.com/download/success) |
16 |
| -- open anaconda prompt and navigate to the local checkout folder of the repository |
| 15 | +- download Miniforge3 from [the miniforge github](https://github.com/conda-forge/miniforge?tab=readme-ov-file#download) and install it with the recommended settings. |
| 16 | +- open Miniforge Prompt and navigate to the local checkout folder of the repository |
17 | 17 | - ``conda create --name kw_env python=3.11 git spyder -y`` (``git`` and ``spyder`` are optional)
|
18 | 18 | - ``conda activate kw_env``
|
19 | 19 | - ``python -m pip install -e .[dev,docs,examples]`` (pip developer mode, any updates to the local folder are immediately available in your python. It also installs all requirements via pip, square brackets are to install optional dependency groups)
|
|
40 | 40 |
|
41 | 41 | ## Running the testbank
|
42 | 42 |
|
43 |
| -- open anaconda prompt and navigate to the local checkout folder of the repository |
| 43 | +- open Miniforge Prompt and navigate to the local checkout folder of the repository |
44 | 44 | - ``conda activate kw_env``
|
45 | 45 | - ``pytest`` (runs all tests)
|
46 | 46 | - the pytest testbank also runs automatically on Github for every PR (for different python versions and package versions)
|
47 | 47 |
|
48 | 48 | ## Generate html documentation
|
49 |
| -- open anaconda prompt and navigate to the local checkout folder of the repository |
| 49 | +- open Miniforge Prompt and navigate to the local checkout folder of the repository |
50 | 50 | - ``conda activate kw_env``
|
51 | 51 | - ``sphinx-build docs docs/_build``
|
52 | 52 | - the documentation is also automatically updated upon every push/merge to the main branch
|
53 | 53 |
|
54 | 54 | ## Increase the version number
|
55 | 55 |
|
56 | 56 | - commit all changes via git
|
57 |
| -- open anaconda prompt and navigate to the local checkout folder of the repository |
| 57 | +- open Miniforge Prompt and navigate to the local checkout folder of the repository |
58 | 58 | - ``conda activate kw_env``
|
59 | 59 | - ``bumpversion major`` or ``bumpversion minor`` or ``bumpversion patch``
|
60 | 60 | - the version number of all relevant files will be updated, as stated in setup.cfg
|
0 commit comments