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 docs about installing Julia #290

Merged
merged 44 commits into from
Oct 30, 2023
Merged

Update docs about installing Julia #290

merged 44 commits into from
Oct 30, 2023

Conversation

rdprins
Copy link
Collaborator

@rdprins rdprins commented Oct 18, 2023

Context: Julia dependencies (added in order to stabilize the recurrence relation: #274)

Description of the Change: Added Manifest.toml and Project.toml which specify the julia version and dependencies. Updated the README and development guide to instruct the user to install julia and to instantiate the toml files. This means PyJulia now runs in the environment defined by the toml files, rather than in Julia's base environment.

  • When installing via devcontainer, julia (v1.9.3) is installed and the environment is instantiaded.
  • When installing via MakeFile, the environment is only instantiaded when Julia was previously installed by the user.
  • When installing via poetry install or pip install, the julia installation and environment instantiation need to be performed by the user.

Benefits:

Possible Drawbacks:

Related GitHub Issues:

@codecov
Copy link

codecov bot commented Oct 18, 2023

Codecov Report

Merging #290 (91bf6b6) into develop (b5975f6) will increase coverage by 0.28%.
The diff coverage is 100.00%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #290      +/-   ##
===========================================
+ Coverage    80.03%   80.32%   +0.28%     
===========================================
  Files           57       57              
  Lines         4858     4858              
===========================================
+ Hits          3888     3902      +14     
+ Misses         970      956      -14     
Files Coverage Δ
mrmustard/utils/settings.py 98.27% <100.00%> (ø)

... and 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b5975f6...91bf6b6. Read the comment docs.

README.md Outdated Show resolved Hide resolved
@rdprins rdprins marked this pull request as ready for review October 25, 2023 11:31
README.md Outdated Show resolved Hide resolved
@ziofil ziofil self-requested a review October 27, 2023 21:44
Copy link
Collaborator

@ziofil ziofil left a comment

Choose a reason for hiding this comment

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

great!

@rdprins rdprins merged commit ac1509d into develop Oct 30, 2023
6 checks passed
@rdprins rdprins deleted the update_docs_julia branch October 30, 2023 18:11
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.

4 participants