SciMLTutorials.jl  by SciML

Tutorials for scientific machine learning (SciML) and differential equations

created 8 years ago
734 stars

Top 47.1% on SourcePulse

GitHubView on GitHub
Project Summary

This repository provides a collection of tutorials for Scientific Machine Learning (SciML) and high-performance differential equation solving using Julia. It targets researchers and engineers looking for practical examples to complement official documentation and explore the SciML ecosystem. The tutorials offer hands-on guidance for applying advanced computational methods.

How It Works

The tutorials are primarily authored as Weave.jl files (.jmd), which are then compiled into various formats including interactive Jupyter notebooks, PDFs, and HTML webpages. This approach allows for a single source of truth that can be rendered into multiple user-friendly formats, facilitating both learning and reproducibility. The generation process is automated via CI, enabling contributions by simply updating the source files.

Quick Start & Requirements

  • Install: ]add SciMLTutorials#master
  • Activate & Instantiate: ]activate SciMLTutorials, ]instantiate
  • Run: using SciMLTutorials, SciMLTutorials.open_notebooks()
  • Dependencies: Requires Julia. Specific tutorial notebooks may require additional packages, which can be installed by activating the respective tutorial subfolder's environment (e.g., Pkg.activate(joinpath(pkgdir(SciMLTutorials),"tutorials","models")); Pkg.instantiate()).
  • More Info: tutorials.sciml.ai

Highlighted Details

  • Demonstrates practical applications of SciML and differential equation solving.
  • Tutorials are generated from Weave.jl files for automated compilation.
  • Interactive Jupyter notebooks can be generated locally.
  • Computer characteristics are displayed at the bottom of tutorial benchmarks.

Maintenance & Community

This repository is part of the SciML ecosystem. Bug reports and issues should be filed at the SciMLTutorials repository.

Licensing & Compatibility

The repository does not explicitly state a license in the provided README. This requires further investigation for commercial use or closed-source linking.

Limitations & Caveats

The project is currently deprecated, with tutorials migrated to respective package repositories. While it may be revived, the current state indicates a lack of active development for this specific aggregation. Manual package instantiation is required for running notebooks if not using the internal project TOMLs.

Health Check
Last commit

5 days ago

Responsiveness

1 day

Pull Requests (30d)
2
Issues (30d)
0
Star History
1 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.