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

added WSL and Anaconda instructions #872

Merged
merged 2 commits into from
Aug 13, 2024

Conversation

rekomodo
Copy link
Contributor

@rekomodo rekomodo commented Aug 8, 2024

Proposed changes

Add instructions to install WSL on windows and install Anaconda on WSL/Linux #866 .

Types of changes

What types of changes does your code introduce to FESTIM?

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code refactoring
  • Documentation Update (if none of the other choices apply)
  • New tests

Checklist

  • Black formatted
  • Unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

Testing on a fresh WSL default image is pending.

Copy link

codecov bot commented Aug 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.56%. Comparing base (375c7b2) to head (b91960f).
Report is 50 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #872   +/-   ##
=======================================
  Coverage   99.56%   99.56%           
=======================================
  Files          61       61           
  Lines        2750     2750           
=======================================
  Hits         2738     2738           
  Misses         12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rekomodo rekomodo marked this pull request as ready for review August 9, 2024 17:17
@rekomodo
Copy link
Contributor Author

rekomodo commented Aug 9, 2024

Double-checked that the commands worked on a default (Ubuntu) WSL install.

@RemDelaporteMathurin RemDelaporteMathurin linked an issue Aug 9, 2024 that may be closed by this pull request
Copy link
Collaborator

@RemDelaporteMathurin RemDelaporteMathurin left a comment

Choose a reason for hiding this comment

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

Thanks @rekomodo I think this will greatly help! One day we will try to couple this with an installation video.

Could you try to also tackle #837 while we're there? I think it would just be adding a sentence or two at the very top (before installing Fenics) saying that we need to first install FEniCS the main dependency and then install FESTIM.

@rekomodo
Copy link
Contributor Author

Latest commit implements what I got from #837 .

Copy link
Collaborator

@RemDelaporteMathurin RemDelaporteMathurin left a comment

Choose a reason for hiding this comment

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

Thanks @rekomodo !

@RemDelaporteMathurin RemDelaporteMathurin linked an issue Aug 13, 2024 that may be closed by this pull request
@RemDelaporteMathurin RemDelaporteMathurin merged commit c8a0c66 into festim-dev:main Aug 13, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: 2-step installation for FESTIM
2 participants