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

Installation instructions lacking #436

Closed
stefanv opened this issue Jan 11, 2022 · 10 comments
Closed

Installation instructions lacking #436

stefanv opened this issue Jan 11, 2022 · 10 comments
Assignees
Labels

Comments

@stefanv
Copy link
Member

stefanv commented Jan 11, 2022

Currently, the scipy README refers to https://www.scipy.org/install/ as the most up-to-date source of source installation instructions.

However, that page only says:

SOURCE PACKAGES
You can build any of the packages from source. Those involved in development may take this route to get developmental versions or alter source code. Refer to individual projects for more details.

This is not very helpful.

@rgommers
Copy link
Member

That's because this was the SciPy ecosystem install page. We should just link to the docs.

When we're updating, let's also fix the rest. It was pointed out earlier today that conda-forge/miniforge/mambaforge are not mentioned at all. I'd say Mambaforge is my first recommendation these days.

@stefanv
Copy link
Member Author

stefanv commented Jan 11, 2022

I am trying to build SciPy, and am unable to do so. I feel like a complete n00b 😂

Just a cryptic:

  FileNotFoundError: [Errno 2] No such file or directory: '/home/stefan/src/scipy/scipy/_lib/highs/CMakeLists.txt'

EDIT: related to submodule update; should also be mentioned in README, since that wasn't necessary before.

So, maybe we also need to link to instruction updates related to the meson build process?

@stefanv
Copy link
Member Author

stefanv commented Jan 11, 2022

The dev docs also say:

Information on how to install SciPy and/or the SciPy Stack (a larger set of packages for scientific computing with Python) can be found at https://scipy.org/install/.

This is when clicking on "in-depth instructions" in the developer docs getting started section.

@ev-br
Copy link
Member

ev-br commented Jan 11, 2022

FileNotFoundError: [Errno 2] No such file or directory: '/home/stefan/src/scipy/scipy/_lib/highs/CMakeLists.txt'

Just seen it a couple of days back, with a regular setup. py build. Felt just the same :-).
I think it's fixed by a git submodule update

@rgommers
Copy link
Member

git submodule update --init should fix that one.

@rgommers
Copy link
Member

So, maybe we also need to link to instruction updates related to the meson build process?

Not yet, since it's not very well tested yet and is only 100% robust on Linux + OpenBLAS at the moment. Give it 3 more months.

@tupui
Copy link
Member

tupui commented Jan 11, 2022

Re mamba, this is so great! I started using this last week and cannot go back to something else!!

@tupui
Copy link
Member

tupui commented Jan 12, 2022

That's because this was the SciPy ecosystem install page. We should just link to the docs.

Do you mean that we should link /install to https://scipy.github.io/devdocs/getting_started.html?

When we're updating, let's also fix the rest. It was pointed out earlier today that conda-forge/miniforge/mambaforge are not mentioned at all. I'd say Mambaforge is my first recommendation these days.

And then just take care of https://scipy.github.io/devdocs/getting_started.html?

+1 for this and we could rename install to getting started. The button linking to /install already says get started. Would be more consistent.

@rgommers
Copy link
Member

Do you mean that we should link /install to https://scipy.github.io/devdocs/getting_started.html?

No, just for "building from source" to link to https://scipy.github.io/devdocs/dev/contributor/contributor_toc.html#development-environment. Our website should have the main advice. Building from source is niche now (and as difficult as ever still), and should not be presented on scipy.org to the average user.

@tupui
Copy link
Member

tupui commented Feb 7, 2023

This is actually fixed and I think the page is in good shape now. Closing.

@tupui tupui closed this as completed Feb 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants