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.

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

57 add documentation #71

Merged
merged 15 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -156,4 +156,5 @@ dmypy.json
cython_debug/

# VSCode
.vscode
.vscode

4 changes: 3 additions & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,6 @@ to see if someone already filed the same issue;
- [push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the stmtools repository on GitHub;
- create the pull request, e.g. following [the instructions: creating a pull request](https://help.github.com/articles/creating-a-pull-request/).

In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.
In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.

In case you want to add documentation and you don't have mkdocs installed in your root environment, you can install it by calling ```pip install -e .[docs]```. You can then test your documentation by calling ```mkdocs serve```.
Binary file added docs/img/Four-level_Z.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Example Notebook\n",
"# Example Operations\n",
"\n",
"In this example notebook, we will demonstrate how to:\n",
"\n",
Expand Down Expand Up @@ -102,7 +102,7 @@
"source": [
"path_stm = Path('./stm.zarr')\n",
"stmat = xr.open_zarr(path_stm)\n",
"stmat = stmat.chunk({\"space\": 10000, \"time\":-1}) # Chunk 10000 space, no chunk in time\n",
"stmat = stmat.chunk({\"space\": 10000, \"time\": -1}) # Chunk 10000 space, no chunk in time\n",
"\n",
"print(stmat)"
]
Expand Down
Loading
Loading