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

Update installation documentation #69

Merged
merged 3 commits into from
Apr 2, 2024
Merged

Update installation documentation #69

merged 3 commits into from
Apr 2, 2024

Conversation

connoramoreno
Copy link
Collaborator

Rewrites the installation instructions to reflect updates to dependencies. Also streamlines the installation process to reduce the number of steps. Confirmed to work with a new Conda test environment.

Closes #62.

@connoramoreno connoramoreno linked an issue Mar 29, 2024 that may be closed by this pull request
@connoramoreno connoramoreno changed the title Modify installation documentation Update installation documentation Mar 29, 2024
@connoramoreno connoramoreno linked an issue Mar 29, 2024 that may be closed by this pull request
@Edgar-21
Copy link
Contributor

Should we add a yml environment file that matches these install instructions? Both for users and for use in the dockerfile for testing. I have one that is similar but not identical that I have been using while writing the dockerfile, but it would probably be best to have it match the install guide.

We could also add a little paragraph mentioning that the conda and pip stuff can be obtained using the yml file.

@connoramoreno
Copy link
Collaborator Author

Oh, that's a good idea. I'll add a YML file soon.

Copy link
Member

@gonuke gonuke left a comment

Choose a reason for hiding this comment

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

Thanks for making these changes - just a few lingering suggestions and/or questions for discussion

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
environment.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@gonuke gonuke left a comment

Choose a reason for hiding this comment

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

@gonuke gonuke merged commit 2f183db into oo_version Apr 2, 2024
@connoramoreno connoramoreno mentioned this pull request Apr 3, 2024
@connoramoreno connoramoreno deleted the installation branch April 26, 2024 20:14
connoramoreno pushed a commit that referenced this pull request Sep 10, 2024
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.

confirm installation process installation errors
3 participants