Metadata-Version: 2.1
Name: f04profile
Version: 0.2.0
Author: Nicolas Cordier
Author-email: nicolas.cordier@numeric-gmbh.ch
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.8
Requires-Dist: snakeviz

================
MYSTRAN profiler
================

MYSTRAN F04 log file parser

Features
========

This package installs a ``f04prof`` command.

Usage
=====

Create a .prof file by entering the following command::

        $ f04prof path/to/myfile.F04

This will create ``path/to/myfile.prof``. You can then visualize it with ``snakeviz`` (`<https://https://pypi.org/project/snakeviz/>`_).

To automatically trigger snakeviz, pass ``-s`` flag::


        $ f04prof -s path/to/myfile.F04

Or::

        $ f04prof path/to/myfile.F04 -s

Install
=======

The installation process will install ``snakeviz`` as dependency. Use ``pipx`` to install it in a user contained environment::

        $ pipx install f04profile
