https://github.com/jij-inc/jijmodeling-tutorials

Tutorial and Learning materials for JijModeling
https://github.com/jij-inc/jijmodeling-tutorials

jijmodeling mathematical-programming ommx optimization

Last synced: 4 months ago
JSON representation

Tutorial and Learning materials for JijModeling

• Host: GitHub
• URL: https://github.com/jij-inc/jijmodeling-tutorials
• Owner: Jij-Inc
• License: cc0-1.0
• Created: 2024-09-05T12:33:31.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-07-23T04:53:02.000Z (11 months ago)
• Last Synced: 2025-07-23T06:25:04.122Z (11 months ago)
• Topics: jijmodeling, mathematical-programming, ommx, optimization
• Language: HTML
• Homepage: https://jij-inc.github.io/JijModeling-Tutorials/
• Size: 2.06 MB
• Stars: 3
• Watchers: 8
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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](https://about.readthedocs.com/).

| Language | Path | Read The Docs |

|----------|------|--------------|

| English  | [docs/en](./docs/en) | [![Book-EN](https://img.shields.io/badge/Read_The_Docs-English-blue)](https://jij-inc-jijmodeling-tutorials-en.readthedocs-hosted.com/en/) |

| 日本語   | [docs/ja](./docs/ja) | [![Book-JA](https://img.shields.io/badge/Read_The_Docs-日本語-blue)](https://jij-inc-jijmodeling-tutorials-ja.readthedocs-hosted.com/ja/) |

> [!TIP]

> Learning materials for JijModeling v1.x.y is deployed to GitHub Pages. Please refer to [here](https://jij-inc.github.io/JijModeling-Tutorials/en/introduction.html).

For questions about JijModeling, we provide community support through the following Discord channels. Please feel free to join us.

| Language | Discord |

|----------|---------|

| English  | [![Discord-EN](https://img.shields.io/badge/Discord-English-default?logo=Discord)](https://discord.gg/bcP4g4ar6J) |

| 日本語   | [![Discord-JP](https://img.shields.io/badge/Discord-日本語-default?logo=Discord)](https://discord.gg/34WkHwvY3Y) |

## For Contributors

When contributing to this repository, please note the following:

- Install [uv](https://docs.astral.sh/uv/getting-started/installation/), [task](https://taskfile.dev/installation/), and [yq](https://mikefarah.gitbook.io/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