Skip to content

Jij-Inc/JijModeling-Tutorials

Repository files navigation

Learning materials for JijModeling

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 Book-EN
日本語 docs/ja Book-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 Discord-EN
日本語 Discord-JP

For Contributors

When contributing to this repository, please note the following:

  • Install uv, task, and yq for development.
  • Use task commands to easily build JupyterBook documentation and add release notes, etc. Run task -l to see available commands.
  • For updates to JijModeling v2.x.y learning materials, create your branch from the jijmodeling2 branch.
  • The .ipynb files under the book directory and .md files under the markdowns directory are synchronized via jupytext. When using generative AI to update learning materials, we recommend editing files under the markdowns directory.
  • Before submitting a Pull Request, run task check_book_en, task check_book_ja, and task check_paired_notebooks to ensure no errors occur.

Tip

For updates to JijModeling v1.x.y learning materials, create your branch from the main branch

Contributors 11