Add new Build Prerequisites page #31
Conversation
There was a problem hiding this comment.
Thanks @hauten! Few inline suggestions below but other than that, LGTM!
| +-------------+----------+--------------------------+ | ||
| | Requirement | Version | Notes | | ||
| +=============+==========+==========================+ | ||
| | `libsoduim` | `>1.0.1` | | |
There was a problem hiding this comment.
| | `libsoduim` | `>1.0.1` | | | |
| | `libsodium` | `>1.0.1` | | |
| Lua | ||
| --- | ||
|
|
||
| Flux makes use of Lua scripts and bindings for some functionality. Lua 5.1 is required for now. However, support for v5.2 and v5.3 is planned in the near future. |
There was a problem hiding this comment.
The original source material was out-of-date. Sorry about that.
| Flux makes use of Lua scripts and bindings for some functionality. Lua 5.1 is required for now. However, support for v5.2 and v5.3 is planned in the near future. | |
| Flux makes use of Lua scripts and bindings for some functionality. Lua 5.1 or 5.2 are required. |
| +-------------+----------+--------------------------+ | ||
| | Requirement | Version | Notes | | ||
| +=============+==========+==========================+ | ||
| | `python` | `>=2.7` | | |
There was a problem hiding this comment.
We just recently went python 3.6+. 🎆
| | `python` | `>=2.7` | | | |
| | `python` | `>=3.6` | | |
| +-------------+----------+--------------------------+ | ||
| | `pycparser` | `>=2.2` | | | ||
| +-------------+----------+--------------------------+ | ||
| | `ply` | `>=3.6` | | |
There was a problem hiding this comment.
Hmmmm. I don't think I've ever seen this dependency. @trws did this used to be a dependency for the bindings at some point in time? I don't think it is anymore, right? Same for pycparser? We don't explicitly depend on it but transitively do through cffi?
There was a problem hiding this comment.
I think we also have dependencies on jsonschema and yaml. But that can be a separate PR.
There was a problem hiding this comment.
Yeah, we have explicit dependencies on jsonschema and yaml, which we should really provide a requirements.txt for or similar I suppose. I think ply is used by pycparser, and pycparser by cffi. We currently do not directly depend on pycparser, but we might soon as it looks like it might be a promising way to do some fixing in the binding generation I mentioned not too long ago.
FWIW, if you go to the bottom of the PR, click "Show all check", then click "Details" for the read-the-docs check, it should bring you to a live view of the PR, built by RTD. |
|
@hauten are you still interested in contributing this? It might be hard to maintain given how quickly dependencies and versions change. If you want to drop the PR, I think that would be OK, but if you want to pick it back up, I think we could have a link under "Manual Installation." https://flux-framework.readthedocs.io/en/latest/quickstart.html#manual-installation The reason to put it there is because anyone doing the docker install doesn't care about building (they get it ready to go in a container) and the spack install will always keep updated dependencies. If we do have this list, I'm wondering if we would want to just list the general dependencies without pinning versions, and use the sections to primarily describe how each is used. It would be a "did you know" for the advanced / interested developer (if I had to scope the goal of listing them). If we want to direct a reader that is looking for an actual set of "the current deps and versions to install" we probably want to point to a file in GitHub that is doing the building (and regularly updated) and not have to maintain that information in two places. |
This is from the effort to move the original docs into Sphinx/RtD; I was involved only in the initial migration, not maintenance since then. I agree that keeping it updated with various versions is onerous, and I'm sure Flux has changed a lot in the time since. Feels like an obsolete PR. |
|
Ok thanks for the update (and you are a hero for doing that! 🙌) let’s close the PR then. |
Three commits involved in copying content from http://flux-framework.org/docs/requirements/ into a new .rst file for this repo. Preview isn't working for me in VS, so please let me know if I need to make any formatting corrections. Resolves the last task on flux-framework/flux-framework.github.io#36. Closes: #36