mirror of
https://github.com/dwinkler1/np.git
synced 2026-02-19 22:40:57 -05:00
Add comprehensive inline documentation to all modules and enhance README
Co-authored-by: dwinkler1 <22460147+dwinkler1@users.noreply.github.com>
This commit is contained in:
parent
c19248f706
commit
40095ac868
13 changed files with 587 additions and 32 deletions
|
|
@ -1,5 +1,28 @@
|
|||
# Julia-related host configurations
|
||||
#
|
||||
# This module defines all Julia-related commands available in the dev shell.
|
||||
# Julia is configured with project-local package management.
|
||||
#
|
||||
# Available commands (when Julia is enabled):
|
||||
# - <name>-jl: Launch Julia REPL with project environment
|
||||
# - <name>-pluto: Launch Pluto.jl notebook server
|
||||
# - <name>-initJl: Initialize Julia project and install Pluto
|
||||
#
|
||||
# How it works:
|
||||
# - All commands use --project=. to activate local Project.toml
|
||||
# - JULIA_NUM_THREADS=auto enables multi-threading
|
||||
# - Packages are managed via Julia's built-in Pkg manager
|
||||
#
|
||||
# Project setup:
|
||||
# 1. Run <name>-initJl to create Project.toml
|
||||
# 2. Add packages: julia --project=. -e 'using Pkg; Pkg.add("PackageName")'
|
||||
# 3. Packages are stored in Project.toml and Manifest.toml
|
||||
#
|
||||
# Dependencies: julia-bin (configured in flake.nix)
|
||||
config: pkgs: {
|
||||
# jl: Julia REPL with project environment
|
||||
# Activates local Project.toml for package management
|
||||
# Use Pkg.add("PackageName") to install packages
|
||||
jl = {
|
||||
enable = config.enabledLanguages.julia;
|
||||
path = {
|
||||
|
|
@ -8,6 +31,9 @@ config: pkgs: {
|
|||
};
|
||||
};
|
||||
|
||||
# initJl: Initialize Julia project
|
||||
# Creates Project.toml and installs Pluto.jl notebook
|
||||
# Run this once to set up Julia package management
|
||||
initJl = {
|
||||
enable = config.enabledLanguages.julia;
|
||||
path = {
|
||||
|
|
@ -16,6 +42,10 @@ config: pkgs: {
|
|||
};
|
||||
};
|
||||
|
||||
# pluto: Launch Pluto.jl interactive notebook
|
||||
# Auto-installs Pluto if not present in Project.toml
|
||||
# Opens browser with notebook interface
|
||||
# Notebooks are reactive - cells update automatically
|
||||
pluto = let
|
||||
runPluto = ''
|
||||
import Pkg; import TOML; Pkg.instantiate();
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue