Metadata-Version: 2.1
Name: virtual-ipm
Version: 2.1.2
Summary: Virtual-IPM is a software for simulating IPMs and other related devices.
Home-page: https://gitlab.com/IPMsim/Virtual-IPM
Author: Dominik Vilsmeier
Author-email: d.vilsmeier@gsi.de
License: AGPL-3.0
Project-URL: Documentation, https://ipmsim.gitlab.io/Virtual-IPM/
Project-URL: Code, https://gitlab.com/IPMsim/Virtual-IPM
Project-URL: Issue tracker, https://gitlab.com/IPMsim/Virtual-IPM/-/issues
Keywords: IPM,BIF,beam instrumentation,beam diagnostics,transverse profile monitor,simulation,framework
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Requires-Dist: anna (>=0.4.1)
Requires-Dist: injector (==0.12.1)
Requires-Dist: ionics
Requires-Dist: numpy (>=1.18)
Requires-Dist: pandas
Requires-Dist: pyhocon
Requires-Dist: rx (<3.0)
Requires-Dist: scipy
Requires-Dist: six
Provides-Extra: gui
Requires-Dist: PyQt5 ; extra == 'gui'
Requires-Dist: matplotlib (>=3.2) ; extra == 'gui'
Provides-Extra: obstacles
Requires-Dist: trimesh[easy] ; extra == 'obstacles'

.. image:: https://gitlab.com/IPMsim/Virtual-IPM/-/raw/develop/logo.svg
   :align: center
   :width: 100%


Virtual-IPM
===========

Virtual-IPM is a software which combines efforts towards simulations of Ionization Profile Monitors
and was developed for the IPMSim collaboration. It has been designed with focus on flexibility and
extensibility in order to cover a broad range of
`use cases <https://ipmsim.gitlab.io/Virtual-IPM/use-cases.html>`_.
It combines aspects of a framework
- which enables `developers <https://ipmsim.gitlab.io/Virtual-IPM/developers/introduction.html>`_
to realize their own ideas - as well as of a stand-alone application which allows
`users <https://ipmsim.gitlab.io/Virtual-IPM/usage.html>`_ to effortlessly specify and run their own cases.


Installation
------------

Virtual-IPM can be installed via ``pip`` with or without GUI components. ``pip install Virtual-IPM[GUI]`` installs
the application together with the graphical user interface while ``pip install Virtual-IPM`` just installs the command
line version. For more information see `the documentation <https://ipmsim.gitlab.io/Virtual-IPM/installation.html>`_.


Relevant links
--------------

* `Documentation <https://ipmsim.gitlab.io/Virtual-IPM/>`_
* `Changelog / Release notes <https://ipmsim.gitlab.io/Virtual-IPM/changelog.html>`_
* `Examples <https://ipmsim.gitlab.io/Virtual-IPM/examples.html>`_
* `Virtual-IPM on PyPI <https://pypi.org/project/virtual-ipm/>`_


