omtool 0.2.0
Package and program that models N-Body problem in galactic evolution application.
License: Apache-2.0
Requires Python: >=3.10,<4.0

Open Modeling Tool
***********************

Description
###############
OMT (Open Modeling Tool) is used to numerically solve and visualize N-body problem with huge number of particles. Primary application is galactic evolution. 

Prerequisites
###############
It requires following packages to work:

.. code-block:: bash

   pip install marshmallow marshmallow_jsonschema matplotlib pandas pyyaml argparse astropy py_expression_eval amuse-framework

You also need to install `pyfalcon <https://github.com/GalacticDynamics-Oxford/pyfalcon>`__ module which makes integration possible.

You might also need:

.. code-block:: bash

   pip install flake8 isort mypy black types-pyyaml

Usage
###############
Program has three modes: creation, integration and analysis. The semantical difference between them is as follows:

* ``[data -> Snapshot]`` Creation mode creates snapshot from data. This data might be particles specified by their position, velocity and mass or the whole files with particle parameters inside them. 
* ``[Snapshot -> Snapshot]`` Integration mode alters existing snapshot. It takes some existing snapshot and performs some operation on it, then takes result and performs operation again and again until some specified condition is not met. 
* ``[Snapshot -> data]`` Analysis mode creates data from snapshot. It takes some snapshot and extracts some data (position, velocities, potentials, energies, etc.) then saves it to some form of file (image or log file).

Creation
==============
This module is responsible for initialization of snapshots. You can create `configuration YAML file <https://github.com/Kraysent/OMTool/blob/main/examples/creation_config.yaml>`__ which describes list of objects in the snapshot (single objects and ``*.csv`` files are supported for now).

The output is single FITS file which has two HDUs: empty primary one (it is required by FITS standard) and binary table with positions, velocities and masses of each particle in the system. It also stores timestamp T = 0 in the header. 

You can start it with

.. code-block:: bash

   python main.py create /path/to/config/file.yaml

Integration
==============
This module is responsible for actual integration of the model from previous module. It operates similarly: you create `configuration file <https://github.com/Kraysent/OMTool/blob/main/examples/integration_config.yaml>`__ with all the data necessary. Next step is to launch 

.. code-block:: bash

   python main.py integrate /path/to/config/file.yaml

It will print some info into console and gradually produce output FITS file. Each HDU of this file would contain timestamp in the ``TIME`` header and table with fields ``[x, y, z, vx, vy, vz, m]``. Be aware that depending on number of particles it can take quite a lot of disk space.

Analysis
==============

This module is responsible for the visualization of file with snapshots (for example, one from previous module). As always, you should create `configuration file <https://github.com/Kraysent/OMTool/blob/main/examples/analysis_config.yaml>`__. The biggest part of it is description of matplotlib's plots layout. Launch command:

.. code-block:: bash

   python main.py analize /path/to/config/file.yaml

If done right it should produce a lot of pictures (the same amount as number of timestamps in the input file) similar to this one: 

.. image:: docs/source/images/image.png

**This program is under heavy development so some things (or all of them) might work not as expected or not work at all.**