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.

Sign up for GitHub

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

Jump to bottom

Update docs for 2.6.0 #138

Merged
merged 23 commits into from
Nov 22, 2023
Merged

Update docs for 2.6.0 #138

merged 23 commits into from
Nov 22, 2023

Conversation

vasdommes
Copy link
Collaborator

@vasdommes vasdommes commented Oct 5, 2023 •
edited
Loading

TODO:

  • Changelog
  • 2.5.1 -> 2.6.0
  • Installation instructions for HPC: Caltech, Expanse, Harvard, BU, Imperial
  • Example batch scripts
  • Move all blocks_3d and scalar_blocks instructions from sdpb to their own repos.
  • Docker instructions
  • Podman instructions
  • Singularity instructions
  • Move LaTeX and PDF for Outer_Limits and SDPB_Manual to separate folders
  • Move JSON schemas to docs/json_schema
  • Minor improvements
  • Add known issues and workarounds to documentation #143

@vasdommes vasdommes added the docs label Oct 5, 2023
@vasdommes vasdommes added this to the 2.6.0 milestone Nov 14, 2023
@vasdommes vasdommes changed the title Update docs Update docs for 2.6.0 Nov 14, 2023
@vasdommes
Update Caltech.md
86a6303 
- Fresh instructions, new module versions
- Added useful links etc.

NB: Did not check scalar_blocks and blocks_3d instructions!
@vasdommes
Update Expanse.md
c752f90 
- Fresh instructions, new module versions
- Added useful links etc.

NB: Did not check scalar_blocks and blocks_3d instructions!
@vasdommes
Update Harvard.md
c781d6d 
- Fresh instructions, new module versions
- Added useful links etc.

NB: Did not check scalar_blocks instructions!
@vasdommes
Add docs/site_installs/Boston.md (BU cluster installation for 2.6.0)
f9dda56
@vasdommes
Usage.md: add note about loading modules
7e7ec23
@vasdommes
Update docs/site_installs/Readme.md
6658d7e
@vasdommes
Update Install.md: C++14 -> C++17
7417a5c
@vasdommes
Move JSON schemas to docs/json_schema
df9b814
@vasdommes
Remove unused SDPB-PMP-Description.png
0e7a41d 
Removed from Readme.md in 26c9b83
@vasdommes
Move LaTeX and PDF for Outer_Limits and SDPB_Manual to separate folders.
e66c743
@vasdommes
Usage.md: note that optimal performance is when the number of MPI job…
8cfd9b1 
…s is comparable to the number of blocks.
@vasdommes
Update Singularity.md, add link to Apptainer and instructions for bui…
a0373ab 
…lding from source via Docker
@vasdommes
Update Docker.md
6cb25de 
Added:
- link bootstrapcollaboration/sdpb repo
- instructions for building from sources
- Podman
- minor improvements
@vasdommes
site_installs: Remove obsolete Docker.org, sdpb_Dockerfile, sdpb_dev_…
e45a576 
…Dockerfile

See ./Dockerfile for build, ./docs/Docker.md for instructions
@vasdommes
Remove references to scalar_blocks and blocks_3d from new installatio…
bf6d1b7 
…n instructions.

The instructions were moved to the corresponding repos:
https://gitlab.com/bootstrapcollaboration/scalar_blocks
https://gitlab.com/bootstrapcollaboration/blocks_3d
@vasdommes
Add links to existing installations for BU, Caltech, Expanse, and Har…
e8bd723 
…vard cluster
@vasdommes
2.5.1 -> 2.6.0 in documentation
8069893
@vasdommes
Add 2.6.0 to Changelog.md
ac90ab6
@vasdommes
Add docs/site_installs/Imperial.md (Imperial College London HPC insta…
ba964e8 
…llation)
@vasdommes
Add link to SDPB example script to Boston.md, Caltech.md, Expanse.md,…
22612cc 
… and Harvard.md
@vasdommes
site_installs: add comment ./waf # -j 1
332e305 
sometimes waf crashes if run not single-threaded
@vasdommes
Fix #143 Add known issues and workarounds to documentation
d0a6b6f 
Added to Usage.md:
- choosing optimal number of cores
- reducing memory usage
- crashes with large sdp.zip
- spectrum not working in parallel
- spectrum not finding zeros
@vasdommes vasdommes marked this pull request as ready for review November 21, 2023 03:38
@vasdommes vasdommes merged commit d6b948b into master Nov 22, 2023
2 checks passed
@vasdommes vasdommes deleted the docs branch November 22, 2023 18:05
@vasdommes vasdommes mentioned this pull request Nov 28, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
2.6.0
Development

Successfully merging this pull request may close these issues.
1 participant
@vasdommes