Welcome to the PyMAD-NG documentation!

Getting Started

• Introduction to PyMAD-NG
  • What is PyMAD-NG?
  • Why Use PyMAD-NG?
  • How PyMAD-NG Works
  • Example Workflow
  • Key Features of PyMAD-NG
  • Who Should Use PyMAD-NG?
  • Next Steps
• Installation & Setup
  • System Requirements
  • Installing PyMAD-NG
  • Updating PyMAD-NG
  • Uninstalling PyMAD-NG
  • Using a Custom MAD-NG Executable
  • Understanding pymadng.MAD Object Initialization
  • Debugging Tips
  • Next Steps
• Quick Start Guide
  • Step 1: Create a MAD Instance
  • Step 2: Load a Sequence
  • Step 3: Set Up a Beam
  • Step 4: Run a Twiss Calculation
  • Step 5: Analyse the Results
  • Step 6: Visualise the Optics
  • Additional Tips
  • What Next?

Core Concepts

• Communication with MAD-NG
  • Protocol Overview
  • Supported Data Types
  • Converting TFS Tables to DataFrames
  • Avoiding Deadlocks
  • Scope: Local vs Global
  • Customising the Environment
  • Summary
• Useful Functions & Objects in PyMAD-NG
  • Top-Level Objects in pymadng
  • Global Utility Modules
  • Global Functions from Lua
  • MAD Physics Libraries
  • Importing MAD-NG Modules via PyMAD-NG
  • Core Communication Methods
  • Reference Objects and Evaluation
  • Table Conversion
  • Listing Available Globals
  • Quoting Strings
  • Summary
• PyMAD-NG Architecture Overview
  • High-Level Overview
  • Communication Pipeline
  • Core Components
  • Data Types and Serialization
  • Dynamic Attributes & Autocompletion
  • Protected Execution
  • Summary

Advanced Topics

• Advanced Features in PyMAD-NG
  • Understanding _last[] Temporary Variables
  • Function and Object References in MAD-NG
  • Real-Time Feedback with Python During Matching
  • Using PyMAD-NG with Multiprocessing
  • Loading and Using External MAD Files and Modules
  • Exporting Results for External Use
  • Combining with NumPy and Pandas
  • Managing Larger Workflows
  • Summary of Advanced Features
• Debugging & Troubleshooting in PyMAD-NG
  • 1. Enable Debug Mode
  • 2. Inspecting Command History
  • 3. Communication Rules
  • 4. Handling Errors
  • 5. Debugging Subprocess Behavior
  • 6. Common Pitfalls & Solutions
  • 7. Cleaning Up
  • 8. Summary

Examples

• LHC Example
  • Loading the LHC
  • Receiving intermediate results
• List of Examples
  • FODO Cell Example
  • PS Twiss Example
  • LHC Example
  • Managing References Example
  • Receiving Data from the LHC Example

Reference

• API Reference
  • PyMAD-NG Module contents
  • Useful functions for MAD References
• Developer API Reference
  • PyMAD-NG Low Level API (Able to be run independently of madp_object)
  • PyMAD-NG Reference Layer for Object Communication
  • Helper Functions for Communicating Strings to MAD-NG
  • Special Last Object Handler
• Contributing and Extending PyMAD-NG
  • Overview of Repository Structure
  • Getting Started
  • Development Workflow
  • Best Practices
  • Documentation
  • Questions or Issues?

Indices and tables

• Index

• Module Index

• Search Page