Developer guide#
Start here to change GWexpy or its documentation. For an analysis workflow, use Start Here.
Task |
Source of guidance |
|---|---|
Set up a checkout and submit a change |
|
Understand containers and processing layers |
|
Review numerical and metadata behavior |
|
Run validation |
|
Find internal contracts and design decisions |
Build the public documentation#
Use the project’s gwexpy Conda environment with the documentation dependencies.
From a source checkout, prepare a fresh temporary directory outside the repository:
python scripts/prepare_public_docs.py /tmp/gwexpy-docs-preview/docs_redesign
python -m sphinx -b html /tmp/gwexpy-docs-preview/docs_redesign /tmp/gwexpy-docs-preview/html
python -m sphinx -b html -D language=ja /tmp/gwexpy-docs-preview/docs_redesign /tmp/gwexpy-docs-preview/html/ja
python scripts/check_public_docs.py /tmp/gwexpy-docs-preview/html
Use a new output directory on subsequent runs. Preparation reads canonical notebook code and keeps execution output outside the checkout. English public prose and Japanese gettext catalogs are maintained together. When changing a notebook’s executable cells, edit its canonical source and run the preparation step; the public notebook supplies the narrative and translation identities.
Studio#
GWexpy Studio is a separate interface under development. It is not required to complete these tutorials. A Studio learning path will be added after its distribution and basic workflows can be reproduced. Until then, the downloadable Python examples are the supported entry to the learning material.