-
Notifications
You must be signed in to change notification settings - Fork 25
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
Instructions for installation (Ubuntu/WSL) #310
Comments
Thank you for this suggestion. I think that there's a balance to be struck: general suggestions, which won't require frequent updating, are a good idea, but any more detailed instructions are likely to go out of date quite quickly. In this sense, I'm a little concerned about steps 1 and 2 in your instructions above but I'm happy to discuss this further. My feeling is that the Conquest installation instructions should make it clear what kind of packages are required, but not how to install these. I think that it's an excellent idea to an appropriate system.make as an example (with comments at the top making it clear what it is). |
I think this is a good idea to provide examples for installation to new users (particulary students). There are pros and cons for providing system-specific full install recipies including libraries. I would say that this can help even if there are expected to change quickly. |
It may also be put in a separate page for specific systems (ex: Ubuntu 22.04/23.04; Windows 10/11, MacOs14, etc.), with an archive page to refer to older systems. As written by @lionelalexandre, it would be useful for beginners, students or in general people would would like to test CONQUEST on their personal computer. For production use on supercomputers by confirmed users, the main page in its current state is clear enough, I think. |
After rethinking a bit about it, here are some additional thoughts:
What about creating specific pages for different systems in the installation section, like in ABINIT? Then, there is no need to strike a balance if we have:
Such a system.make file is proposed in 5228d14. Maybe we could standardize the naming scheme for example
Thank you for your feedback. |
Thank you @AugustinLu for your continuing suggestions: they're really helpful. I think that the ABINIT example is a very good one, and I would be happy for us to go ahead along these lines. In terms of |
An alternative would be using the The idea behind the current system of
I admit that is a lot to ask from a novice, but I'm not confident we can provide something that will always work out of the box. I don't have any experience with WSL but we can try to find out how different things look over there. Personally for non-expert users who just need to install and run a release version, I would recommend going down the Another route would be using containers, where we provide a Ubuntu-22.04 (for example) image with CONQUEST and all dependencies pre-installed. This is not ideal for HPC systems, but could work on personal machines. |
Thank you for your comment. I don't know about While I understand that in its current state, compilation should not be working out-of-the-box, I find it confusing to have a generic
These are the typical instructions that would help new users if they can be found in a specific page of the documentation, which would require minimal effort to update the next year if the next release of the OS or compiler breaks it. Often, changing 1-2 options should fix it.
Typically, Ubuntu in WSL is working like a regular Ubuntu (at least the 22.04 version I am currently using), thus expect the absence of the desktop environment, packages can be installed as usual and there is little to no difference between a native Ubuntu and the WSL virtual machine, when it comes to compiling and using CONQUEST. Personally, this is approach I am using for testing compilation and runs of CONQUEST before production runs on supercomputers.
This is a good approach for tutorials. Note that it is already available with MateriApps . |
At present, there is an
installation
section in the documentation, which describes how to compile the code in general.However, it would be convenient and attractive for new users to have specific sections dedicated to specific systems besides the HPC ones, for instance MacOS, Linux or Windows. In particular, recent versions of Windows (10 and 11) have the Windows Subsystem for Linux, allowing for seamless use of a Linux virtual machine.
Here, we propose a detailed procedure to install required packages and compile CONQUEST on Ubuntu. The following have been tested so far:
To be provided as system.make.ubuntu or some similar name
This could also be useful for Windows/Ubuntu users at tutorial/hands-on sessions.
Any feedback is welcome.
Thank you.
The text was updated successfully, but these errors were encountered: