Update install docs #3350
Merged
Update install docs #3350
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
neutrinoceros
force-pushed
the
update_install_docs
branch
4 times, most recently
from
63b13e1
to
371892f
Compare
15 tasks
|
I think I am in agreement with the goals of this reworking. I am going to provide comments now. |
matthewturk
approved these changes
Jun 18, 2021
neutrinoceros
force-pushed
the
update_install_docs
branch
from
6365800
to
4fc1e20
Compare
neutrinoceros
force-pushed
the
update_install_docs
branch
from
4fc1e20
to
425f022
Compare
Co-authored-by: Matthew Turk <matthewturk@gmail.com>
|
I think with a second review we should consider merging this. |
Co-authored-by: Britton Smith <brittonsmith@gmail.com>
… the script around for now)
brittonsmith
approved these changes
Jun 23, 2021
brittonsmith
approved these changes
Jun 23, 2021
|
Since the only failure is fixed in #3373 I'm going to merge this. |
jzuhone
reviewed
Jun 23, 2021
jzuhone
reviewed
Jun 23, 2021
jzuhone
approved these changes
Jun 23, 2021
Co-authored-by: John ZuHone <jzuhone@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
fix #3244
There is a lot going on in our installation guide and I'm trying to reduce it as much as I can.
I'm going to assume readers know a way to setup isolated envs instead of trying to teach them various tools all at once.
I will probably need some assistance in updating Conda-related instructions since I haven't used it in a while, but I'll try my best to go as far as possible without help.
Here are my guidelines for this work:
I have separated the general instructions from the ones specific to the all-in-one installation script, because this part alone makes up for more than half the material and IMHO should only be used as a last-resort or a quick-and-dirty way to setup yt for a workshop. While the diff is pretty large, most of it comes from that separation, and in general, most of the text is rearranged or repurposed, but I'm not really adding much new material.
Note on Cartopy:
it seems to me that users who need cartopy+yt are the most likely to want a conda install, since it's (in)famously not trivial to install with pip. I'll need to address this at the top level of the document but I still want to keep it as brief as possible.