SciMLTutorials.jl

repository·master·Indexed 20 days ago

https://github.com/sciml/scimltutorials.jl

A collection of tutorials in PDF, webpage, and Jupyter notebook formats demonstrating practical applications of the SciML Scientific Machine Learning ecosystem. This library is deprecated, with tutorials moving to individual package repositories; it remains available for accessing legacy collections and generating notebooks locally via SciMLTutorials.open_notebooks().

Tokens
604
Snippets
3
Records
4
Agent score
23%

What's inside SciMLTutorials.jl

  1. Access SciML Tutorials online

    master

    You can view the SciML tutorials in various formats (PDF, webpage, interactive notebooks) via the hosted website.

    Note: This library is currently deprecated. Tutorials have been moved to the repositories of their respective individual packages. Use this repository primarily for accessing the legacy collection or generating notebooks locally.

  2. Install dependencies for specific tutorial folders

    master

    When running generated notebooks, the required packages are not automatically installed. To ensure all dependencies for a specific tutorial category (e.g., models) are available, activate that specific subfolder's environment and instantiate it.

    using Pkg
    Pkg.activate(joinpath(pkgdir(SciMLTutorials),"tutorials","models"))
    Pkg.instantiate()
  3. Generate interactive Jupyter notebooks locally

    master

    To generate interactive notebooks from the tutorial source files, you must install the package, instantiate the environment, and call SciMLTutorials.open_notebooks(). The notebooks will be generated in a folder named generated_notebooks within your current working directory (pwd()).

    ]add SciMLTutorials#master
    ]activate SciMLTutorials
    ]instantiate
    using SciMLTutorials
    SciMLTutorials.open_notebooks()
  4. Manually generate tutorial files using Weave

    master

    If you need to manually trigger the generation process for specific files or folders using the internal Weave logic, use the following functions:

    # Generate a single specific file
    SciMLTutorials.weave_file(joinpath(pkgdir(SciMLTutorials),"tutorials","models"),"01-classical_physics.jmd")
    
    # Generate all files within a specific folder
    SciMLTutorials.weave_folder(joinpath(pkgdir(SciMLTutorials),"tutorials","models"))
    
    # Generate all notebooks in the entire repository
    SciMLTutorials.weave_all()