Move util docs, install instructions into top level docs #380
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
mcgibbon
changed the title
elynnwu
reviewed
Nov 14, 2022
| $ python3 -m venv venv_name | ||
| $ source venv_name/bin/activate | ||
|
|
||
| Inside of your pace `venv` or conda environment pip install the Python requirements, GT4Py, and Pace: |
There was a problem hiding this comment.
Should we also mention installing lint and docs with just different requirement name?
| Communication | ||
| ============= | ||
|
|
||
| As mentioned when discussing :ref:`State`, each process or "rank" on a cubed sphere is responsible for a subset of the cubed sphere grid. |
There was a problem hiding this comment.
The reference to State is not showing up when I build it locally, is something missing?
There was a problem hiding this comment.
Same here, fixed by adding manual anchors to the missing pages.
docs/util/communication.rst
Outdated
|
|
||
| .. doctest:: | ||
|
|
||
| >>> quantity.view[:] = np.arange(4)[None, :] + np.arange(4)[:, None] |
There was a problem hiding this comment.
Can we do something like np.arange(4)[None, :] + 2*np.arange(4)[:, None] so that there isn's two repeated [3,4,5,6] for the example?
There was a problem hiding this comment.
Switched to ones and tens.
docs/util/utilities.rst
Outdated
| State can be persisted to disk using either :py:func:`pace.util.write_state` (described below) | ||
| or :py:class:`pace.util.ZarrMonitor`. The latter will coordinate between ranks to | ||
| write state to a unified Zarr store. Initializing it requires passing grid information. | ||
| State can be persisted to disk using either :py:func:`pace.util.write_state` (described below) or :py:class:`pace.util.ZarrMonitor`. |
|
launch jenkins |
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.
Purpose
This PR moves the documentation for pace-util into the top level of the repo, and copies install instructions from the README into the sphinx docs (to be deleted from the README later when we can link to the sphinx docs).
Changes: