Skip to content

macOS installation instructions#144

Draft
logan-nc wants to merge 3 commits intodevelopfrom
macOS_installation_instructions
Draft

macOS installation instructions#144
logan-nc wants to merge 3 commits intodevelopfrom
macOS_installation_instructions

Conversation

@logan-nc
Copy link
Collaborator

@logan-nc logan-nc commented Feb 5, 2026

Added exhaustive step-by-step macOS setup guide to docs/src/set_up.md covering:

  • Installing Xcode Command Line Tools and Homebrew
  • Installing Julia (via Homebrew or official installer)
  • Installing Fortran compiler (gfortran)
  • Installing Python/Jupyter for notebooks
  • Cloning JPEC repository
  • Building Fortran dependencies (libspline.dylib and libvac.dylib)
  • Installing Julia packages via Pkg.instantiate()
  • Running the DIIID-like example notebook
  • Troubleshooting common issues
  • Optional VS Code setup

Instructions are written for complete beginners (high school students) with no prior Julia experience.

…s for beginners

Added exhaustive step-by-step macOS setup guide to docs/src/set_up.md covering:
- Installing Xcode Command Line Tools and Homebrew
- Installing Julia (via Homebrew or official installer)
- Installing Fortran compiler (gfortran)
- Installing Python/Jupyter for notebooks
- Cloning JPEC repository
- Building Fortran dependencies (libspline.dylib and libvac.dylib)
- Installing Julia packages via Pkg.instantiate()
- Running the DIIID-like example notebook
- Troubleshooting common issues
- Optional VS Code setup

Instructions are written for complete beginners (high school students) with no prior Julia experience.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@logan-nc logan-nc requested a review from jhalpern30 February 5, 2026 20:39
@logan-nc logan-nc added the documentation Improvements or additions to documentation label Feb 5, 2026
@jhalpern30
Copy link
Collaborator

My "review" on this will be based on Calin's success/lack of success following these - if he can follow everything, then I'll just skim through but it should be good

logan-nc and others added 2 commits February 12, 2026 21:40
Updated all documentation files to reflect the new unified JPEC organization:
- Main entry point now at src/JPEC.jl instead of src/DCON/Main.jl
- DCON module renamed to ForceFreeStates (ideal MHD stability)
- Unified jpec.toml configuration replaces separate dcon.toml and equil.toml
- Added references to new modules: ForcingTerms and PerturbedEquilibrium
- Updated type references: DconControl → ForceFreeStatesControl
- Updated file paths in examples and agent descriptions
- Clarified that "DCON-style" refers to methodology, not module name
- Updated output file references to jpec.h5 as primary output

Files modified:
- CLAUDE.md: Updated module references and future work section
- .github/copilot-instructions.md: Updated architecture and configuration
- .claude/agents/clean-code-reviewer.md: Updated module list and output files
- .claude/agents/julia-performance-optimizer.md: Updated module list and examples

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@logan-nc logan-nc marked this pull request as draft February 13, 2026 23:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants