diff --git a/README.md b/README.md index dd5eb0d..fd541ff 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,13 @@ We suggest to use *miniconda* as package manager for your system. Create and activate conda environment with: ```bash -conda env create -f environment.yaml +conda env create -f environment.yml conda activate wsi-pre2 ``` -## Code quality +## Coding best practices + +The main branch is protected. Please checkout your own development branch and draft a Pull Request to commit changes. This repository uses pre-commit hooks and Github Actions for code quality, inspired by the [Lightning Hydra Template](https://github.com/ashleve/lightning-hydra-template). diff --git a/environment.yaml b/environment.yaml deleted file mode 100644 index 392367d..0000000 --- a/environment.yaml +++ /dev/null @@ -1,17 +0,0 @@ -name: wsi-pre2 -channels: - - defaults - - conda-forge -dependencies: - - pip - - python=3.9.* - - openslide=3.4.1 # C-Library, latest release from 2015 - - openslide-python=1.2.0 # Python binding, release from 2022 - - pre-commit=3.* - - pip: - - opencv-python==4.5.5.62 - - Pillow==9.5.0 - - pandas==1.5.2 # Before switching from Numpy to Apache Arrow backend - - numpy==1.24.4 - - matplotlib==3.7.* - - tqdm==4.66.1 diff --git a/environment.yml b/environment.yml new file mode 100644 index 0000000..f0ebd93 --- /dev/null +++ b/environment.yml @@ -0,0 +1,17 @@ +name: wsi-pre2 +channels: + - defaults + - conda-forge +dependencies: + - pip + - python=3.9.* + - openslide=3.4.1 # C-Library, latest release from 2015 + - openslide-python=1.2.0 # Python binding, release from 2022 + - pre-commit=3.* + - pip: + - opencv-python==4.5.5.62 + - Pillow==9.5.0 + - pandas==1.5.2 # Before switching from Numpy to Apache Arrow backend + - numpy==1.24.4 + - matplotlib==3.7.* + - tqdm==4.66.1