From 17c20cb70d18d1ed45866f537bcebfac6474888f Mon Sep 17 00:00:00 2001 From: SatoshiTerasaki Date: Wed, 11 Sep 2024 22:23:15 +0900 Subject: [PATCH] Format README.md and add setup instructions for T4APlutoExamples --- README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/README.md b/README.md index e69de29..a474c5a 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,53 @@ +# T4APlutoExamples + +This repository contains tutorials for tensor4all group written in Julia with Pluto notebook. + +## Setup + +- Install Julia + +```sh +$ git clone https://github.com/tensor4all/T4APlutoExamples.git +$ cd T4APlutoExamples +$ julia + _ + _ _ _(_)_ | Documentation: https://docs.julialang.org + (_) | (_) (_) | + _ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help. + | | | | | | |/ _` | | + | | |_| | | | (_| | | Version 1.10.5 (2024-08-27) + _/ |\__'_|_|_|\__'_| | Official https://julialang.org/ release +|__/ | + +julia> using Pkg; Pkg.activate("."); Pkg.instantiate() +julia> Pkg.status() +Status `~/tensor4all/T4APlutoExamples/Project.toml` + [98e50ef6] JuliaFormatter v1.0.60 + [c3e4b0f8] Pluto v0.19.46 + [2fc8631c] PlutoSliderServer v0.3.31 +``` + +## Launch Pluto Notebook + +Let's run our Pluto notebook `pluto_notebooks/quantics1d.jl` for instance: + +```sh +$ julia --project + _ + _ _ _(_)_ | Documentation: https://docs.julialang.org + (_) | (_) (_) | + _ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help. + | | | | | | |/ _` | | + | | |_| | | | (_| | | Version 1.10.5 (2024-08-27) + _/ |\__'_|_|_|\__'_| | Official https://julialang.org/ release +|__/ | + +julia> using Pluto; Pluto.run(notebook="pluto_notebooks/quantics1d.jl") +``` + +This will launch a Pluto notebook server immediately. + +## How to learn more about Pluto.jl + +See the official Pluto.jl tutorial [🔎 Basic Commands in Pluto](https://github.com/fonsp/Pluto.jl/wiki/%F0%9F%94%8E-Basic-Commands-in-Pluto) to learn more. +