Add installation scripts + update documentation with Zensical#8
Merged
Add installation scripts + update documentation with Zensical#8
Conversation
…lready cloned SPIDER. needs testing.
…s a nested clone in PROTEUS
…er correctly using Zensical's footnotes
…rd to find as they are placed in the root directory
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
timlichtenberg
requested changes
Mar 21, 2026
Member
timlichtenberg
left a comment
There was a problem hiding this comment.
A few comments, looks great otherwise. I will give the explanations part and how-to another look once i update it for further Zalmoxis coupling
Member
|
I also tested the install scripts on macos; all works well for me. Good new logic, much improved from the PROTEUS one; I will see if I can take some of this over into PROTEUS at the next PR. |
Author
Thanks! I'll incorporate your suggestions by tomorrow (and will try to fix the suddenly failing check 😢) |
Co-authored-by: Tim Lichtenberg <lichtenberg.tim@gmail.com>
Co-authored-by: Tim Lichtenberg <lichtenberg.tim@gmail.com>
Co-authored-by: Harrison Nicholls <32022679+nichollsh@users.noreply.github.com>
…' into ks/fix_installation
Author
|
@nichollsh @timlichtenberg I believe everything is covered now :) |
nichollsh
approved these changes
Mar 23, 2026
This file contains hidden or 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
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.
Description
This PR introduces a more complete installation and documentation workflow for SPIDER.
1. Add installer scripts for SPIDER and PETSc
This PR adds the scripts
get_spider.shandget_petsc.shto provide a more consistent installation path for SPIDER. It aligns the standalone SPIDER installation process with the workflow already documented in PROTEUS. The scripts:PROTEUS/SPIDERrepository layout./tools/get_spider.sh.Specifically, most of the output (i.e. warnings due to deprecation issues, etc) during installation are now logged in a file to keep the terminal clean. On the long term these deprecation issues should probably be fixed.
This closes #3.
2. Add Zensical support and expand the documentation
This PR also implements Zensical and significantly expands the SPIDER documentation.
New and updated files:
How-to/installation.mdhas been updated with the new scriptsHow-to/quadruple_installation.mdis a new file with the quadruple precision installationHow-to/external_mesh_inputexplains how to use an external mesh file as explained in the READMEHow-to/test.mdexplains how to test SPIDERgetting_started.mdis a new getting started page with a quick path and optionsproteus_framework.mdcontains info about PROTEUS and is the landing page for other modulesExplanations/contains many new files so that the model overview, directly converted from the LaTeX files in thenotes/, is complete. Could use updates in the future, of coursemkdocs.ymland.github/workflows/docs.yamlhave been updated accordingly, and there is a new css extra to configure the style.Finally I have added a new job in CI.yml to test the new installation script alongside the normal build.
Validation
I have installed SPIDER and PETSc myself using these scripts and tested everything. In my case, everything worked (Linux on the Habrok cluster).