Related Pages
Here is a list of all related documentation pages:
 Text Formats | Text formats are input and output file formats used by load_text and save_text functions in snapshot class |
| Getting Started with Swarm-NG | The guidelines on using Swarm-NG |
| Advanced Options for Building Swarm | Swarm provides options in both configuration and complilation stage |
| Configuration Files | Text-based configuration files are used to feed parameters into swarm utility |
| Release notes | Version 1.0 This is the first stable release of Swarm-NG |
| swarm-query.py command-line interface | Swarm-query.py (located at SOURCE_DIRECTORY/py/bin/swarm-query.py) is a utility written in Python that provides a command-line interface to the basic querying functionalities of BDB log querying API (refer to Query API) |
| Swarm command-line interface | Swarm executable is a command line user interface to Swarm-NG package |
| How to Test Swarm | The Swarm source distribution contains various test suites for testing Swarm's functionality |
| Using Swarm | Once you build Swarm-NG library, you can use the command-line interface by invoking the executable bin/swarm |
| Examining records from the log file. | The Swarm-NG log files consists of records, these records are encoded in binary and are accessed through swarmng.logrecord.LogRecord class |
| Plotting results from a log file | In this tutorial, we are going to explore how to examine the contents of a log file generated by Swarm-NG library |
| Tutorial on using the Ensemble data structure. | In this tutorial, we demonstrate how to generate an ensemble from a mathematical description |
| Advanced tutorial for using GPU integrators | The basic API gives you control for selecting integrators and using them |
| Tutorial for implementing an Integrator | If you are planning to implement a new ODE integration algorithm for use with Swarm and a propagator is not enough for your needs, you may consider writing an integrator |
| Tutorial for making a monitor (stopper/logger) | A “monitor” class is responsible for determining when the system state should be logged and when the GPU should cease integrating a given system |
| Tutorial for Making a Propagator | A propagator class implements a device function that advance one system by one time step for one system (or at least attempts one timestep) |
| Beginner Python Tutorial | In this tutorial, we explore the basic functionality of Swarm-NG, note that this tutorial is too short and only covers commonly used API |
| Testing for ejection of planets | In this tutorial, we write a test to examine if the stop_on_ejection monitor works as expected |
| Tutorial for generating ensembles | In this tutorial, we will see how to generate test cases and save/load them from files |
| Advanced Python Integration Tutorial | In this tutorial, we explore the different ways to examine an ensemble before and after integration |
| Resume an integration | In this tutorial, we explore more details about data files and integration |
| Extracting statistical information from data files | In this tutorial, we revisit loading ensembles and extracting information from an ensemble; however, this time we are building a small utility to view statistical information about the contents of the ensemble |
| Beginner tutorial for using the API | You can write your own scenarios for integrating ensembles and use parts and pieces of the Swarm-NG library for your C++ application |
| Todo List | |
 Deprecated List |
