Skip to content

HPC-SimTools/IPS-framework

Repository files navigation

Integrated Plasma Simulator (IPS) Framework

IPS is an environment to orchestrate complex coupled simulation workflows on parallel computers. The IPS is designed primarily for use in a batch-processing environment, with a batch job typically comprising a single invocation of the framework, calling the individual physics codes many times as the simulation progresses.

The user documentation can be found at https://ips-framework.readthedocs.io

Bug reports (including security bugs) and enhancement requests can be made using GitHub issues

Alternatively the developers can be contacted at discussions

Contributing

Change requests can be made using GitHub pull request

A guide for developing IPS-framework can be found at Developer Guide

Installing IPS-framework:

The easiest way to install the latest version is from PyPI. For more details see Getting Started

python -m pip install ipsframework

Running IPS

See the User Guides for detailed information on how to run IPS.

ips.py --help
ips.py --config=simulation.config --platform=platform.conf

CI codecov Documentation Status CII Best Practices