Skip to content

USCqserver/HOQSTTutorials.jl

Repository files navigation

HOQSTTutorials.jl

Tutorials for Hamiltonian Open Quantum System Toolkit (HOQST). This repo is inspired by SciMLTutorials, so the workflow is the same. Because currently HOQSTTutorials.jl is not officially registered, you need to install this package manually.

Table of Contents

Contributing

First of all, make sure that your current directory is HOQSTTutorials. All of the files are generated from the Weave.jl files in the tutorials folder. To run the generation process, do for example:

using Pkg, HOQSTTutorials
cd(joinpath(dirname(pathof(HOQSTTutorials)), ".."))
Pkg.pkg"activate ."
Pkg.pkg"instantiate"
HOQSTTutorials.weave_file("introduction","01-closed_system.jmd")

To generate all of the notebooks, do:

HOQSTTutorials.weave_all()

If you add new tutorials that require new packages, simply updating your local environment will change the project and manifest files. When this occurs, the updated environment files should be included in the PR.