Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Make Anaconda environment very easy to setup #82

Merged
merged 7 commits into from
Jan 18, 2022

Conversation

treee111
Copy link
Owner

@treee111 treee111 commented Jan 17, 2022

This PR…

  • sharpens and creates new anaconda .yml files
  • enables users to easily create a anaconda environment with all relevant python packages
  • adjusts the docu & copyToDist file accordingly (to have only the wahoo_user.yml and legacy requirements.txt in the .zip)

Considerations and implementations

.yml files with only the installed packages were installed via

conda env export > environment.yml --from-history

and the .yml files with the dependencies via

conda env export > environment.yml

more information on documentation for sharing anaconda environments

How to test

  1. move to the root folder of wahooMapsCreator in terminal/cmd
  2. create anaconda environment via
conda env create --prefix ./envs -f ./conda_env/enduser.yml
  1. activate anaconda environment with the command printed out
conda activate <PATH_TO_FOLDER>/wahooMapsCreator/envs
  1. User wahooMapsCreator
python wahoo_map_creator.py malta 

Pull Request Checklist

- NEW wahoo_user.yml for endusers (only runtime relevant packages)
- FIXED VERSIONS developer.yml (was before "conda-gdal02")
- EXPORT ..mac.yml from 17.01.2022
- EXPORT ..win.yml from 03.11.2021
- LEGACY requirements.txt from 10.09.2021
- to include conda-env wahoo_user file
- to reference to moved requirements.txt
- comment out unused lines
- created via command: "conda env create --prefix ./envs -f conda-wahoo.yml"
treee111 added a commit that referenced this pull request Jan 17, 2022
- EXPORT ..win.yml from 18.01.2022 based on developer.yml
- EXPORT ..mac.yml from 18.01.2022 based on developer.yml
@treee111 treee111 merged commit 975b420 into develop Jan 18, 2022
@treee111 treee111 deleted the anaconda-setup branch January 18, 2022 20:58
treee111 added a commit that referenced this pull request Jan 18, 2022
…aconda environment (#83)

- updates the output files to compare against for malta and liechtenstein
- files created in /conda_env/developer.yml Anaconda environment from #82
- land* osm files changed by #78 

* update test-files to new setup on macOS

- #78
- Updated GDAL from 3.0.2 to 3.4.1 and other packages as well

* update test-files to new setup on Windows

- #78
- Updated GDAL from 3.0.2 to 3.4.1 and other packages as well
treee111 added a commit that referenced this pull request Jan 18, 2022
treee111 added a commit that referenced this pull request Jan 18, 2022
treee111 added a commit that referenced this pull request Jan 19, 2022
- sharpens and creates new anaconda .yml files
- enables users to easily create a anaconda environment with all relevant python packages
- adjusts the docu & copyToDist file accordingly (to have only the wahoo_user.yml and legacy requirements.txt in the .zip)

* refactor conda-env .yml files

- NEW wahoo_user.yml for endusers (only runtime relevant packages)
- FIXED VERSIONS developer.yml (was before "conda-gdal02")
- EXPORT ..mac.yml from 17.01.2022
- EXPORT ..win.yml from 03.11.2021
- LEGACY requirements.txt from 10.09.2021

* refactor copyFiles & quickstarts

- to include conda-env wahoo_user file
- to reference to moved requirements.txt
- comment out unused lines

* adopt gitignore to env in repo folder

- created via command: "conda env create --prefix ./envs -f conda-wahoo.yml"

* rename .yml file

* refactor conda-env .yml files

- EXPORT ..win.yml from 18.01.2022 based on developer.yml

* refactor conda-env .yml files

- EXPORT ..mac.yml from 18.01.2022 based on developer.yml

* update contributing.md with Anaconda info

BREAKING CHANGE:
The recommendation for the initial setup is now to create a virtual Python environment via Anaconda on Windows, macOS or Linux. Installing multiple programs manually with all setup details and problems now belongs to the past.

wahooMapsCreator can now be used much quicker and easier!
treee111 added a commit that referenced this pull request Jan 19, 2022
…rpening Anaconda environment (#83)

- updates the output files to compare against for malta and liechtenstein
- files created in /conda_env/developer.yml Anaconda environment from #82
- land* osm files changed by #78

* update test-files to new setup on macOS

- #78
- Updated GDAL from 3.0.2 to 3.4.1 and other packages as well

* update test-files to new setup on Windows

- #78
- Updated GDAL from 3.0.2 to 3.4.1 and other packages as well
treee111 added a commit that referenced this pull request Jan 19, 2022
treee111 added a commit that referenced this pull request Jan 19, 2022
… up Anaconda environment (#84)

- adjust Anaconda quickstart according to #82
- makes README more attractive and shorter
- extracts usage information to docs/USAGE.md to separate page
- unify Quickstart docu for macOS and Windows and do not link anymore to there from README


* unify Windows and macOS Quickstart

* update readme

* update install docu

* adjust Anaconda quickstart according to #82

* adjust README

* Extract Usage information to separate page

* minor enhancement

* adjust headlines & typo

* update links in README: icons, text and format

* update CONTRIBUTING.md: Add link to installation of Anaconda environment & format
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant