Skip to content

Commit

Permalink
anaconda to miniconda (#133)
Browse files Browse the repository at this point in the history
  • Loading branch information
veenstrajelmer authored Sep 2, 2024
1 parent 1f3c955 commit b00ae0d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ Voor het afleiden van kengetallen als slotgemiddelden, gemiddelde getijkrommen,
De methodieken in deze repository hebben nog geen definitieve status en zijn daarom nog niet geschikt voor productie.

## installation
- open anaconda prompt
- download Miniforge3 from [the miniforge github](https://github.com/conda-forge/miniforge?tab=readme-ov-file#download) and install it with the recommended settings.
- open Miniforge Prompt
- `conda create --name kw_env python=3.11 git -y`
- `conda activate kw_env`
- `pip install git+https://github.com/Deltares-research/kenmerkendewaarden`
10 changes: 5 additions & 5 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@

## Setup local developer environment

- download and install Anaconda 64 bit from [anaconda.com](https://www.anaconda.com/download/success)
- open anaconda prompt and navigate to the local checkout folder of the repository
- download Miniforge3 from [the miniforge github](https://github.com/conda-forge/miniforge?tab=readme-ov-file#download) and install it with the recommended settings.
- open Miniforge Prompt and navigate to the local checkout folder of the repository
- ``conda create --name kw_env python=3.11 git spyder -y`` (``git`` and ``spyder`` are optional)
- ``conda activate kw_env``
- ``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)
Expand All @@ -40,21 +40,21 @@

## Running the testbank

- open anaconda prompt and navigate to the local checkout folder of the repository
- open Miniforge Prompt and navigate to the local checkout folder of the repository
- ``conda activate kw_env``
- ``pytest`` (runs all tests)
- the pytest testbank also runs automatically on Github for every PR (for different python versions and package versions)

## Generate html documentation
- open anaconda prompt and navigate to the local checkout folder of the repository
- open Miniforge Prompt and navigate to the local checkout folder of the repository
- ``conda activate kw_env``
- ``sphinx-build docs docs/_build``
- the documentation is also automatically updated upon every push/merge to the main branch

## Increase the version number

- commit all changes via git
- open anaconda prompt and navigate to the local checkout folder of the repository
- open Miniforge Prompt and navigate to the local checkout folder of the repository
- ``conda activate kw_env``
- ``bumpversion major`` or ``bumpversion minor`` or ``bumpversion patch``
- the version number of all relevant files will be updated, as stated in setup.cfg

0 comments on commit b00ae0d

Please sign in to comment.