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

Handbook #45

Merged
merged 46 commits into from
Nov 12, 2024
Merged

Handbook #45

merged 46 commits into from
Nov 12, 2024

Conversation

pgierz
Copy link
Member

@pgierz pgierz commented Oct 11, 2024 •
edited
Loading

This branch contains most of the handbook...

Preview here: https://pymorize.readthedocs.io/en/doc-handbook/index.html

More to come...

pgierz and others added 23 commits September 30, 2024 14:02
@pgierz
automatically document cerberus Schemas
985e22e
@pgierz
empty root commit for feat/caching
ed30063
@pgierz
wip(pipeline.py): caching attempt 1
32185bd
@pgierz
feat: manual checkpoint
c03f599
@pgierz
feat: Default pipeline will produce a checkpoint immediately before t…
bfa9225 
…riggering any computations to quickly skip ahead to this point (e.g. the Dask task graph will already have been computed)
@pgierz
feat: cli for basic interaction with Prefect cache
36153cf
@siligam
caching files metadata
d4192b3
@pgierz
feat: cli for basic retrieval of an object from the prefect cache
fb32986
@pgierz
chore(filecache.py): cleanup imports
ec66f00
@pgierz
fix(filecache.py): corrected bad recursive argument call in self.add_…
700a4b0 
…file
@pgierz
style(filecache.py): run filecache.py through black
ce29f90
@pgierz
chore(filecache.py): remove uneeded f-string
21093a2
@pgierz
cleanup: removes inspect-cache standalone script, you should use the CLI
eea9f57
@pgierz
wip: handbook for @mandresm's test work
e7e9ab1
@pgierz
merge cerberus
9007270
@pgierz
Merge branch 'main' into doc/handbook
62e1131
@pgierz
wip
7cadae7
@pgierz
wip
9449d3a
@pgierz
typo
ca5b8f1
@pgierz
correction for building blocks
3cae969
@pgierz
standard library
423a9bf
@pgierz
standard library, sortof
3391c3f
@pgierz
fix: flake8 on schema auto-doc-er
32e4587
@pgierz pgierz requested a review from mandresm October 11, 2024 10:42
@pgierz
Copy link
Member Author

pgierz commented Oct 11, 2024

@mandresm: Please make suggestions and improvements here when you go through the handbook. Thanks! :-)

siligam and others added 18 commits October 17, 2024 17:34
@siligam
Merge branch 'main' into feat/caching
9e01394
@siligam
save filecache as csv
16a59b0
@pgierz
doc: unify usage into one document
b50dba4
@siligam
wired up file cache with data loading and as command line argument
98350d2
@pgierz
doc doc
cb35cc3
@pgierz
doc: auto-document command line interface
48a5950
@pgierz
chore(setup.py): alphabetical order for requirements
f728671
@pgierz
doc(filecache.py): doc-strings should be before import statements
377c061
@pgierz
merge caching into handbook
99624e6
@siligam
made file caching persistent
767df5c
@pgierz
feat(pipeline.py): allow user configurable expiration on prefect task…
8630d74 
… cache
@pgierz
wip: forgot to pass kwargs to classmethod from_list
bd89580
@pgierz
Merge remote-tracking branch 'origin/feat/caching' into doc/handbook
66e57ed
@pgierz
feat: filecache actually used now
1923815
@pgierz
feat: filecache actually used now...without syntax error
d75005a
@pgierz
Merge branch 'feat/caching' into doc/handbook
6deb7be
@pgierz
Merge pull request #50 from esm-tools/doc/politics
f5ef77e 
fix: removes political jokes
@pgierz
Merge branch 'main' into doc/handbook
ce8718d
@pgierz pgierz marked this pull request as ready for review November 5, 2024 20:40
@pgierz pgierz dismissed mandresm’s stale review November 8, 2024 16:37

The merge-base changed after approval.

mandresm
mandresm previously approved these changes Nov 8, 2024
View reviewed changes
Copy link
Contributor

@mandresm mandresm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be merged, we will have to make it more complete later, but for now is already pretty good!

@pgierz pgierz merged commit 1de7288 into main Nov 12, 2024
4 checks passed
@pgierz pgierz deleted the doc/handbook branch November 12, 2024 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mandresm mandresm mandresm left review comments

Assignees

@mandresm mandresm

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation for Table Explorer
3 participants
@pgierz @mandresm @siligam