Metadata-Version: 1.1
Name: stagpy
Version: 0.1.0
Summary: Tool for StagYY output files processing
Home-page: https://github.com/mulvrova/StagPy
Author: Martina Ulvrova, Adrien Morison, Stéphane Labrosse
Author-email: UNKNOWN
License: GPLv2
Description: .. image:: https://landscape.io/github/mulvrova/StagPy/master/landscape.svg?style=flat-square
           :target: https://landscape.io/github/mulvrova/StagPy/master
           :alt: Code Health
        
        StagPy
        ======
        
        StagPy is a Python 3 command line tool to read and process StagYY output files
        to produce high-quality figures.
        
        The aim is to have different cases in one file (Cartesian, Spherical Annulus,
        etc).
        
        The code to read the binary output files has been adapted from a matlab version
        initially developed by Boris Kaus.
        
        
        Installation
        ============
        
        StagPy is available with ``pip``. You can install it with the following
        command::
        
            pip install --user stagpy
        
        
        For developers
        --------------
        
        A ``Makefile`` in the git repository allows you to install StagPy in a
        virtual environment.
        
        StagPy uses the following non-standard modules: numpy, scipy, f90nml,
        matplotlib, and seaborn (the latter is optional and can be turned off with the
        ``core.useseaborn`` option). These dependencies will be checked and needed
        installation performed in a virtual environment. If you use Python3.2 or
        encouter problems with the installation, see the troubleshooting section at the
        end of this README.
        
        However, installation of ``numpy`` and ``scipy`` involve heavy building
        operations, it might be better that you (or your system administrator) install
        it with a package manager such as ``homebrew`` on Mac OS or your favorite Linux
        package manager.
        
        The installation process is then fairly simple::
        
            git clone https://github.com/mulvrova/StagPy.git
            cd StagPy
            make
        
        A soft link named ``stagpy`` is created in your ``~/bin`` directory, allowing you
        to launch StagPy directly by running ``stagpy`` in a terminal (provided that
        ``~/bin`` is in your ``PATH`` environment variable).
        
        Two files ``.comp.zsh`` and ``.comp.sh`` are created. Source them respectively in
        ``~/.zshrc`` and ``~/.bashrc`` to enjoy command line completion with zsh and bash.
        Run ``make info`` to obtain the right sourcing commands.
        
        To check that everything work fine, go to the ``data`` directory of the
        repository and run::
        
            stagpy field
        
        Three PDF files with a plot of the temperature, pressure and
        stream function fields should appear.
        
        
        Available commands
        ==================
        
        The available subcommands are the following:
        
        * ``field``: computes and/or plots scalar fields such as temperature or stream
          function;
        * ``rprof``: computes and/or plots radial profiles;
        * ``time``: computes and/or plots time series;
        * ``plates``: plate analysis;
        * ``var``: displays a list of available variables;
        * ``config``: configuration handling.
        
        You can run ``stagpy --help`` (or ``stagpy -h``) to display a help message
        describing those subcommands. You can also run ``stagpy <subcommand> --help``
        to have some help on the available options for one particular sub command.
        
        StagPy looks for a StagYY ``par`` file in the current directory. It then reads
        the value of the ``output_file_stem`` option to determine the location and name
        of the StagYY output files (set to ``test`` if no ``par`` file can be found).
        You can change the directory in which StagYY looks for a ``par`` file by two
        different ways:
        
        * you can change the default behavior in a global way by editing the config
          file (``stagpy config --edit``) and change the ``core.path`` variable;
        * or you can change the path only for the current run with the ``-p`` option.
        
        The time step option ``-s`` allows you to specify a range of time steps in a
        way which mimic the slicing syntax: ``begin:end:gap`` (both ends included). If
        the first step is not specified, it is set to ``0``. If the final step is not
        specified, all available time steps are processed. Here are some examples:
        
        * ``-s 100:350`` will process every time steps between 100 and 350;
        * ``-s 201:206:2`` will process time steps 201, 203 and 205;
        * ``-s 201:205:2`` same as previous;
        * ``-s 5682:`` will process every time steps from the 5682nd to the last one;
        * ``-s :453`` will process every time steps from the 0th to the 453rd one;
        * ``-s ::2`` will process every even time steps.
        
        By default, the temperature, pressure and stream function fields are plotted.
        You can change this with the ``-o`` option (e.g. ``./main.py field -o ps`` to
        plot only the pressure and stream function fields).
        
        
        Troubleshooting
        ===============
        
        *   Python 3.2
        
            By default, the Makefile uses the ``venv`` standard module to create the
            virtual environment. This module is not included with Python 3.2, you will
            need to use the ``virtualenv`` module instead.
        
        *   Matplotlib related error in MacOS
        
            This might be due to the matplotlib backend that is not correctly set. See
            this Stack Overflow question:
            <http://stackoverflow.com/questions/21784641/installation-issue-with-matplotlib-python>
        
        *   Installation fails with ``ImportError: No module named 'encodings'``
        
            This seems to be due to a bug in the venv module with some Python
            installation setups. If installing Python properly with your package
            manager doesn't solve the issue, you can try installing StagPy without any
            virtual environment by using ``make novirtualenv``.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
