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

Conda dev environment #36

Merged
merged 4 commits into from May 12, 2021
Merged

Conversation

ryanlaclair
Copy link
Contributor

What?

A simple addition of an anaconda environment.yml file for use when doing development work on the algorithm toolkit.

Why?

BeamIO has seemed to standardize on conda for environment management across projects. Including an environment file in the repo ensures developers making changes to the algorithm toolkit can focus on the code rather than the setup.

Closes #35

Copy link
Contributor

@wrp5031 wrp5031 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this be a base for the example atk project as well? Or will the example project have its own yml file? If it is used as a base, we should maybe test to make sure Shapely works with Python 3.9. I actually did not even know Python 3.9 was released until now haha.

Also, you are merging a feature branch into master? Was this meant for integration. If meant for master, maybe this should have been a hotfix branch

@ryanlaclair
Copy link
Contributor Author

Will this be a base for the example atk project as well? Or will the example project have its own yml file? If it is used as a base, we should maybe test to make sure Shapely works with Python 3.9. I actually did not even know Python 3.9 was released until now haha

Good point - I didn't originally intend to use it for the example project since that seems to use a regular requirements.txt file. However we could update the example project to use conda if we want. Even with an update to use conda in the example, we shouldn't need to use this as a base - the Algorithm Toolkit runtime dependency libraries should be automatically installed when the ATK is installed.

This environment file would be used for development work, where you cloning the code from github (does not isntall dependencies) rather than pip install (does install dependencies).

@ryanlaclair ryanlaclair changed the base branch from master to integration February 25, 2021 20:53
@wrp5031
Copy link
Contributor

wrp5031 commented Feb 25, 2021

Good point - I didn't originally intend to use it for the example project since that seems to use a regular requirements.txt file. However we could update the example project to use conda if we want. Even with an update to use conda in the example, we shouldn't need to use this as a base - the Algorithm Toolkit runtime dependency libraries should be automatically installed when the ATK is installed.

I think we should have a conda env yml file for the example project, but that is for another discussion.

@chriswilley
Copy link
Collaborator

Good point - I didn't originally intend to use it for the example project since that seems to use a regular requirements.txt file. However we could update the example project to use conda if we want. Even with an update to use conda in the example, we shouldn't need to use this as a base - the Algorithm Toolkit runtime dependency libraries should be automatically installed when the ATK is installed.

I think we should have a conda env yml file for the example project, but that is for another discussion.

I would support that, but we should keep requirements.txt in there also for people who don't use conda.

@ryanlaclair ryanlaclair merged commit e9dc18e into integration May 12, 2021
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.

Conda environment for algorithm toolkit development
3 participants