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 README and documentation with new installation instructions. #98

Merged
merged 3 commits into from
Nov 16, 2023

Conversation

chrisjonesBSU
Copy link
Member

Now that flowermd can be installed from conda-forge, we should update the installation instructions in the README as well as the documentation.

This PR also changes the structure of the environment files. I don't think we really need separate cpu and gpu versions. Instead we can have a regular environment file, and a dev file that includes pytest and pre-commit.

Let me know if you have other ideas about how to best structure the environment files.

Copy link
Collaborator

@marjanalbooyeh marjanalbooyeh left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks a lot Chris :)

Copy link

codecov bot commented Nov 16, 2023

Codecov Report

Merging #98 (f9b1ff4) into main (98a6de8) will not change coverage.
Report is 14 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #98   +/-   ##
=======================================
  Coverage   93.87%   93.87%           
=======================================
  Files          20       20           
  Lines        1550     1550           
=======================================
  Hits         1455     1455           
  Misses         95       95           

@chrisjonesBSU
Copy link
Member Author

Hold off on merging. I think something is broken with the docs.

@chrisjonesBSU chrisjonesBSU added the documentation Improvements or additions to documentation label Nov 16, 2023
@chrisjonesBSU chrisjonesBSU merged commit 531cd82 into cmelab:main Nov 16, 2023
4 checks passed
@chrisjonesBSU chrisjonesBSU deleted the update-readme branch November 16, 2023 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants