devito icon indicating copy to clipboard operation
devito copied to clipboard

misc: Update docker/README.md

Open FabioLuporini opened this issue 1 year ago • 11 comments

  • Mainly updates Docker instructions
  • Split Docker CPU-GPU
  • Add Devito pip package
  • Drop duplicated text

FabioLuporini avatar Jul 25 '22 07:07 FabioLuporini

According to

https://devitocodes.slack.com/archives/CDY6PGHU5/p1658219773567919

we could explain how to launch jupyter notebooks from within docker (eg some sample commands)

We could/should also clarify that the base images at the docker hub should not be used directly as they don't provide devito. Thoughts?

FabioLuporini avatar Jul 25 '22 07:07 FabioLuporini

Codecov Report

Merging #1972 (0876877) into master (85a9aa5) will decrease coverage by 0.12%. The diff coverage is 50.00%.

@@            Coverage Diff             @@
##           master    #1972      +/-   ##
==========================================
- Coverage   87.79%   87.66%   -0.13%     
==========================================
  Files         214      214              
  Lines       37107    37109       +2     
  Branches     5587     5588       +1     
==========================================
- Hits        32578    32533      -45     
- Misses       4006     4055      +49     
+ Partials      523      521       -2     
Impacted Files Coverage Δ
examples/seismic/source.py 83.33% <ø> (ø)
examples/seismic/utils.py 74.65% <50.00%> (ø)
devito/arch/compiler.py 38.05% <0.00%> (-6.04%) :arrow_down:
devito/arch/archinfo.py 37.77% <0.00%> (-4.37%) :arrow_down:
devito/data/allocators.py 78.14% <0.00%> (-1.10%) :arrow_down:
devito/tools/data_structures.py 67.78% <0.00%> (-0.46%) :arrow_down:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

codecov[bot] avatar Jul 25 '22 07:07 codecov[bot]

Maybe we can merge with: https://github.com/devitocodes/devito/pull/1920 ?

georgebisbas avatar Jul 25 '22 07:07 georgebisbas

@georgebisbas sure, I didn't see it, sorry. I can close this PR. Is there anything you want to pull in your 1920? Feel free to copy-paste edits, then I'll close it and delete teh branch

Ah, could you in 1920 also update the docker README tag s.t. it shows "latest" instead of "gpu-4.6.2"? it's trivial, u just need to edit the link

FabioLuporini avatar Jul 25 '22 09:07 FabioLuporini

with this PR we should also edit the docker tag in the main README, to show "latest" rather than gpu-... (@georgebisbas )

FabioLuporini avatar Aug 03 '22 22:08 FabioLuporini

also TODO: fix link to FAQs in the main README.md !!!

FabioLuporini avatar Aug 03 '22 22:08 FabioLuporini

Will push fixes now

georgebisbas avatar Aug 04 '22 06:08 georgebisbas

@George Bisbas when you push again to the README PR, could you also update FAQ.md with the proper set of DEVITO_ARCH flags? https://github.com/devitocodes/devito/blob/master/FAQ.md#table-of-values-for-devito-environment-variables I’ve just realised there are a few missing (nvc, cuda, …) (Asking you so that we avoid multiple useless CI spins)

georgebisbas avatar Aug 08 '22 10:08 georgebisbas

@AtilaSaraiva, thanks for the input. I think that we cannot include something that is not officially under Devito CI and cannot guarantee support (?) I will wait for input from @FabioLuporini and @mloubout.

georgebisbas avatar Aug 23 '22 09:08 georgebisbas

@AtilaSaraiva, thanks for the input. I think that we cannot include something that is not officially under Devito CI and cannot guarantee support (?) I will wait for input from @FabioLuporini and @mloubout.

I can create a CI then no prob. I have already done it for another package under my wing.

AtilaSaraiva avatar Aug 23 '22 11:08 AtilaSaraiva

todo: move docker-related text from download.rst to docker/readme.md

add a special section: #Developing Devito with Docker

georgebisbas avatar Sep 13 '22 15:09 georgebisbas

So what's the status here?

mloubout avatar Oct 12 '22 21:10 mloubout