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 and simplify installation documentation #338

Merged
merged 1 commit into from Jan 14, 2022

Conversation

maurov
Copy link
Member

@maurov maurov commented Jan 14, 2022

fixes #333

@newville I have tried to simplify and clarify the installation page. Unfortunately, it seems that users do not like to understand what is behind the scenes, they just want to install something working, so I have tried to pop out the minimal procedures to get a working (full) Larch installation.

@maurov maurov added this to the 0.9.58 milestone Jan 14, 2022
@maurov maurov requested a review from newville January 14, 2022 15:50
@newville
Copy link
Member

@maurov Thanks for that, it looks very helpful! Would it be reasonable to reverse the order to make go from novice to expert:
1. install from binaries
2. use GetLarch.sh/.bat
3. install into your own Anaconda (or other Python?) environment.

That is, for sure we want to make sure that option 3 works and clearly state that it is a normal thing to want to do, and we want to make sure that can work. But if that's listed first, more novice users (less likely to read to the bottom?) might think they have to try that.

Do you agree?

@maurov
Copy link
Member Author

maurov commented Jan 14, 2022

I have chosen this order on purpose. Most of the users are familiar with Anaconda and most probably have already this distribution installed. If not, the install scripts seem to nicely work on Linux/Mac and Windows. The binaries work on Windows and Mac, but fail on Linux.

This said, feel free to change the order, I am fine with that.

@newville
Copy link
Member

@maurov I'll merge and then rearrange the order a bit.

I think "most users are familiar with Anaconda" must depend greatly on the facility and area of study. Less than half of the beamline scientists at my beamline are familiar with Anaconda, let alone the users (and I've been trying for years!, they all now know that Python is a thing!). Maybe 1/4 of my users would otherwise have Python installed. That matches my experience with users at training courses and support questions.

But also: I totally get that Anaconda instructions are important.

@newville newville merged commit d321547 into xraypy:master Jan 14, 2022
@maurov maurov deleted the updt_doc_install branch January 17, 2022 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants