Documentation maintenance #248
Merged
Conversation
This file contains 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
douglatornell
added
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #248 +/- ##
==========================================
- Coverage 77.73% 77.73% -0.01%
==========================================
Files 133 133
Lines 18771 18769 -2
Branches 1906 1906
==========================================
- Hits 14592 14590 -2
Misses 4112 4112
Partials 67 67
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
dask.distributed 2022.10.0 deprecated the `dask-scheduler` and `dask-worker` CLI commands in favour of `dask scheduler` and `dask worker`.
This commit modifies the instructions in the deployment docs for the persistent dask cluster on `salish` that the `make_averaged_dataset` worker uses. It changes the number of threads for each worker from 4 to 1, the memory limit from automatic to 64G, and worker files will now be stored on the /tmp/ file system instead of /dev/shm shared memory file system. The change to 1 thread per worker is a consequence of reading xCDAT/xcdat#561 (comment). Changing the memory limit and worker file storage are a result of research and testing on 1mar24 (see worklog for details).
The NEMO_Nowcast package is now installed in the readthedocs build environment. So, autodoc mocks for its imports are no longer required. Removing those mocks silences warnings about mocked objects and missing attributes for the `clear_checklist` and `rotate_logs` worker docs.
This resolves an import error that prevents generation of docs for the `make_averaged_dataset` worker on readthedocs.
Changed all the kbd directives in the skookum deployment documentation into inline code. This helps to ensure the correct semantic representation of technical terms and commands. re: issue #126
Changed all the kbd directives in the documentation into inline code. This helps to ensure the correct semantic representation of technical terms and commands. re: issue #126
Two unused Python library imports, pathlib and requests, were removed from wave_height_period.py. This cleanup improves the code readability and efficiency.
The documentation has been updated to reflect the change in the automatic code formatting tool used by the `salishsea_site` and `SalishSeaNowcast` packages. Previously, we were using `yapf`, but switched to `black`.
The documentation now contains a guide for generating passphrase-less RSA and ED25519 key pairs for the remote hosts that SalishSeaCast uses. It includes commands to install the public keys and to edit the ssh configuration file on 'skookum'.
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.
No description provided.