Duplicate installation of Osyris and Yt

blaizot / ramses-tutorials

Check out the read-the-docs version at the link below

https://ramses-tutorials.readthedocs.io/en/latest

8 stars 3 forks source link

Duplicate installation of Osyris and Yt #20

Open jokirosdahl opened 2 weeks ago

jokirosdahl commented 2 weeks ago

There are instructions in both the section on 'setting up a complete environment with conda' and 'instructions to get started on your laptop' for setting up Yt and Osyris (though the Osyris chapter is empty in the latter section). I recommend just removing it from the 'laptop' section.

nbrucy commented 2 weeks ago

Osyris can be installed via pip, not sure whether it's in conda.

jokirosdahl commented 2 weeks ago

Pip comes automatically with conda, so once miniconda is up, running pip to install osyris and yt (and whatever colossus is) is no problem.

nbrucy commented 1 week ago

I think the instruction in 'setting up a complete environment with conda' are also duplicated in the CBP setup tuto.

blaizot commented 1 week ago

I'm re-writing the install instructions. The CBP part has been tested and works. (Osyris is indeed installed with pip, itself installed with conda).

blaizot commented 1 week ago

I pushed changes for the setup documentation. I hope this is more clear. Still a few things to fix:

internal links (to sub-sections) do not work in readthedocs (but do work in the md file ...) -> not sure which to chose...
I think the install of third-party codes should be moved to the tutorials where they are needed, but that the libraries that they use (e.g. fftw, gsl) should still be part of the overall setup. An alternative is to add one doc page per code (e.g. a MUSIC page, a DICE page, etc.) that can be pointed to by all tutorials using these codes ... What do you think ?

nbrucy commented 1 week ago

I think the order of priority for this kind of polishing should be notebooks > docs > md files.
I think having separated pages is a good idea, but I would keep the link to them in the overall setup so people can install all once and for all.