This repository provides learning materials for JijModeling. While JijModeling itself is not open source, the contents of this repository are in the CC0 public domain. The materials is available in both English and Japanese versions, each deployed to Read The Docs.
| Language | Path | Read The Docs |
|---|---|---|
| English | docs/en | |
| 日本語 | docs/ja |
Tip
Learning materials for JijModeling v1.x.y is deployed to GitHub Pages. Please refer to here.
For questions about JijModeling, we provide community support through the following Discord channels. Please feel free to join us.
| Language | Discord |
|---|---|
| English | |
| 日本語 |
When contributing to this repository, please note the following:
- Install uv, task, and yq for development.
- Use
taskcommands to easily build JupyterBook documentation and add release notes, etc. Runtask -lto see available commands. - For updates to JijModeling v2.x.y learning materials, create your branch from the
jijmodeling2branch. - The
.ipynbfiles under thebookdirectory and.mdfiles under themarkdownsdirectory are synchronized viajupytext. When using generative AI to update learning materials, we recommend editing files under themarkdownsdirectory. - Before submitting a Pull Request, run
task check_book_en,task check_book_ja, andtask check_paired_notebooksto ensure no errors occur.
Tip
For updates to JijModeling v1.x.y learning materials, create your branch from the main branch