General-Use Nodal Network Solver (GUNNS)

NOTE this Wiki has been migrated between platforms several times, and recently migrated here from a NASA-specific environment. A lot of page links and text formatting are broken, and much of the content refers to the NASA-specific environment. We'll try to fix broken things and re-write in more general language as we have time.

Overview

• Introduction
• Glossary
• FAQ
• Release_Notes
• GunnsDraw Wiki our model drawing tool using draw.io
• GunnShow Wiki our old & obsolete drawing tool, included for reference for legacy users
• Documents
• NASA Technology Disclosure
• NASA Standards Compliance
• Contact Info

User's Guide

This is for the 'GunnSlingers' who just want to use the existing GUNNS tools to build models and integrate them in a simulation.

• Setup:
  • Getting Started
  • Dependencies
  • Environment Setup - Setting up a native Linux environment...
  • Docker Environments - ...or you can just use Docker
• Training_Courses
• Link help pages
• Sim Bus User's Guide for GUNNS
• Product files in the Trick simulation environment
• Example Space Vehicle Sim
• Understanding the Aspect Architecture
• General_Hints_and_Advice
• Units
• Fluid Aspect
• Electrical Aspect
• Thermal Aspect
• Dynamics Aspect
• Optimization - automatic network tuning with optimization schemes and Trick Monte Carlo
• Runtime Performance - CPU performance benchmarks
• GUNNS & ROSES - GPU-based solver options for speed
• GitHub Workflow (TBD)
• Links & References

Developer Guide

This is for 'GunnSmiths' or those who need to develop or extend GUNNS code. Most often you'll need to modify or extend an existing GUNNS link class or write your own new class or spotter -- then this guide is for you.

• Open source submission guidelines
• File structure of the GUNNS repositories
• Coding & Design Standards
• Run-Time Architecture & Class Diagrams
• Coding for Trick Checkpoint/Restart
• Run-Time Sequence & Sequence Diagrams (TBD)
• Using Links vs. Spotters (TBD)
• The Link Interface (TBD)
• The Spotter Interface (TBD)
• The Solver
• Algebraic Solutions for 2-Node Cases
• Fluid Aspect design specifics
• Electrical Aspect design specifics (TBD)
• Thermal Aspect design specifics (TBD)
• Running Outside of the Trick Environment
• Continuous Integration
• Unit Testing
• Validation Plan