First version of documentation #18
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
Co-authored by: Mario Santa Cruz <[email protected]>
* feat: Initial implementation of global graphs Co-authored by: Mario Santa Cruz <[email protected]> Co-authored-by: Helen Theissen <[email protected]> Co-authored-by: Sara Hahner <[email protected]> Co-authored-by: Jesper Dramsch <[email protected]>
Co-authored-by: Helen Theissen <[email protected]> Co-authored-by: Gert Mertes <[email protected]> Co-authored-by: Jesper Dramsch <[email protected]> Co-authored-by: Gareth Jones <[email protected]> Co-authored-by: Mariana Clare <[email protected]>
theissenhelen
requested changes
Sep 2, 2024
theissenhelen
requested changes
Sep 2, 2024
Co-authored-by: Helen Theissen <[email protected]>
theissenhelen
approved these changes
Sep 3, 2024
theissenhelen
added a commit
that referenced
this pull request
Sep 11, 2024
* Fix (global version) (#12) * Global Encoder-Processor-Decoder graph (#9) * feat: Initial implementation of global graphs + fixes Co-authored by: Mario Santa Cruz <[email protected]> Co-authored-by: Helen Theissen <[email protected]> Co-authored-by: Sara Hahner <[email protected]> Co-authored-by: Jesper Dramsch <[email protected]> * fix: attributes as torch.float32 * new test: attributes must be float32 * fix typo * Homogeneize base builders * improve test docstrings * homogeneize (name as class attribute) * new input config * new default * remove dataclass from attribute classes * fix: config nodes name * 6 generate graphs from icosahedral meshes (#11) * Global Encoder-Processor-Decoder graph (#9) * feat: Initial implementation of global graphs Co-authored by: Mario Santa Cruz <[email protected]> Co-authored-by: Helen Theissen <[email protected]> Co-authored-by: Jesper Dramsch <[email protected]> * fix: attributes as torch.float32 * new test: attributes must be float32 * fix typo * Homogeneize base builders * improve test docstrings * homogeneize (name as class attribute) * new input config * new default * feat: Initial implementation of global graphs Co-authored by: Mario Santa Cruz <[email protected]> * add cli command * Ignore .pt files * run pre-commit * docstring + log erros * initial tests * feat: initial version of AttributeBuilder * refactor: separate into node edge attribute builders * feat: edge_length moved to edges/attributes.py * remove __init__ * bugfix (encoder edge lengths) + refector * feat: support path and dict for `config` argument * fix: error * refactor: naming * fix: pre-commit * feat: builders icosahedral * feat: Add icosahedral graph generation Co-authored-by: Mario Santa Cruz <[email protected]> * refactor: remove create_shere * feat: Icosahedral edge builder * feat: hexagonal graph generation Co-authored-by: Mario Santa Cruz <[email protected]> * feat: hexagonal builders * fix: AOI not implemented yet * fix: abstractmethod and renaming * chore: add dependencies * test: add tests for trimesh * test: add tests for hex (h3) * fix: imports * fix: output type * refactor: delete unused file * refactor: renaming and positioning * feat: ensure src and dst always the same * fix: imports * fix: edge_name not supported * test: add tests for TriIcosahedralEdges * fix: assert missing for Hexagonal edges * test: hexagonal edges * fix: avoid same name * fix: imports * fix: conflicts * update tests * Include xhops to hexagonal edges * docs: update docstrings * fix: update attribute name * refactor: rename multiscale nodes * refactor: rename icosahedral nodes * improve: clarity of function * improve: function syntax * refactor: simplify resolution assignment * refactor: improve variable naming in icosahedral graph generation * more comments * refactor: naming * refactor: separate into functions * refactor: remove unused code * refactor: remove unused options and rename * doc: clarify cells and nodes * fix: add return statements * homogeneize: tri & hex edges * naming: xhops to x_hops * naming: x_hops in docstring * docstring * blank lines * fix: add return statement * simplify icoshaedral edges * feat: select edge builder method based on ico node type * test: adjust tests to new MultiScaleEdges * docs: improve docstrings * fix: remove LAM filtering for icosahedral, leave for next PR * h3 (v4) not supported --------- * [feature] add changelog (#21) * ci: changelog check * feat: add changelog * fix: on develop * Skip no-commit-to-branch in code QA (#17) * Clean nodes after building the graph (#23) * feat: clean graph of unneeded attributes after creation Co-authored-by: Mario Santa Cruz <[email protected]> Co-authored-by: Helen Theissen <[email protected]> Co-authored-by: Jesper Dramsch <[email protected]> * Make graph filename argument optional (#24) * hotfix: make graph saving optional Co-authored-by: Jesper Dramsch <[email protected]> Co-authored-by: Mario Santa Cruz <[email protected]> Co-authored-by: Helen Theissen <[email protected]> * doc: update CHANGELOG Co-authored-by: Jesper Dramsch <[email protected]> * chore: add rtd pr preview * HEALPix nodes (#16) [feature] HEALPix node builder Co-authored-by: theissenhelen <[email protected]> * 25 integrate reusable workflows (#26) * ci: add public pr label * ci: add downstream-ci workflow * ci: add ci-config * fix: pre-commit * docs: update changelog * ci: switch main on downstream-ci * ci: run ci on push on main * Hotfix/clean graph (#28) * Add binary dependencies to ci-config.yml (#29) * Add binary dependencies to ci-config.yml * docs: update changelog --------- Co-authored-by: theissenhelen <[email protected]> * ci: inherit pypi publish flow (#27) * ci: inherit pypi publish flow Co-authored-by: Jesper Dramsch <[email protected]> * docs: update changelog * ci: only downstream-ci for changes in src and tests --------- Co-authored-by: Jesper Dramsch <[email protected]> * Bugfix/31 ensure latlon input numpy array (#32) * #31 Ensure lat lon values passed as numpy arrays * fix formatting * Updated CHANGELOG.md * Remove bug in the graph cleaning function (#33) * fix: remove the bug in the graph cleaning function Co-authored-by: Jesper Dramsch <[email protected]> * docs: update changelog --------- Co-authored-by: Jesper Dramsch <[email protected]> Co-authored-by: Gert Mertes <[email protected]> * Move to reusable workflows for QA and Testing (#34) * ci: move to reusable workflows for QA and Testing * docs: changelog add ci reusable workflow * ci: downstream ci ignore docs * ci: remove anchor, unsupported by github * ci: add changelog release updater (#35) * ci: changelog updater PR (#36) * ci: correct inputs typo * ci: fix changelog updater * docs: ci fixes changelog * ci: premissions * ci: typo * Ci/fix pr permission (#37) * ci: add pull-requests permissions * ci: add on workflow dispatch * ci: remove 3.9 tests (#39) * ci: remove 3.9 tests * ci: remove testing of python 3.9 * dics: update changelog * Fix support for Python 3.9 (#38) * fix: support py3.9 Co-authored-by: Jesper Dramsch <[email protected]> * fix: update & homogeneize changelog * fix: update tests to support py39 * fix: style * ci: rollback 3.9 tests * refactor: annotations not used in tests --------- Co-authored-by: Jesper Dramsch <[email protected]> * Ci/fix_double_notes (#40) * ci: avoid duplication of release notes * ci: try write-all * ci: fix permissions * docs: update changelog * ci: fix indent * Inspection tools (#22) Co-authored-by: Ana Prieto Nemesio <[email protected]> Co-authored-by: Helen Theissen <[email protected]> * [pre-commit.ci] pre-commit autoupdate (#41) updates: - [github.com/psf/black-pre-commit-mirror: 24.4.2 → 24.8.0](psf/black-pre-commit-mirror@24.4.2...24.8.0) - [github.com/astral-sh/ruff-pre-commit: v0.4.6 → v0.6.2](astral-sh/ruff-pre-commit@v0.4.6...v0.6.2) - [github.com/tox-dev/pyproject-fmt: 2.1.3 → 2.2.1](tox-dev/pyproject-fmt@2.1.3...2.2.1) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * [pre-commit.ci] pre-commit autoupdate (#43) updates: - [github.com/astral-sh/ruff-pre-commit: v0.6.2 → v0.6.3](astral-sh/ruff-pre-commit@v0.6.2...v0.6.3) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * First version of documentation (#18) Documentation web page --------- Co-authored-by: Helen Theissen <[email protected]> Co-authored-by: Jesper Dramsch <[email protected]> * [Changelog] Update to 0.3.0 (#44) * [create-pull-request] automated change * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: theissenhelen <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --------- Co-authored-by: Mario Santa Cruz <[email protected]> Co-authored-by: Mario Santa Cruz <[email protected]> Co-authored-by: Jesper Dramsch <[email protected]> Co-authored-by: Gert Mertes <[email protected]> Co-authored-by: Mario Santa Cruz <[email protected]> Co-authored-by: Iain Russell <[email protected]> Co-authored-by: Rilwan (Akanni) Adewoyin <[email protected]> Co-authored-by: Ana Prieto Nemesio <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: theissenhelen <[email protected]>
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.
This PR includes an initial version for the documentation up to the point including the following changes:
The folder and file layout is planned to include more content in some categories in the future.
📚 Documentation preview 📚: https://anemoi-graphs--18.org.readthedocs.build/en/18/