Source code for jscatter.examples

# -*- coding: utf-8 -*-
# written by Ralf Biehl at the Forschungszentrum Jülich ,
# Jülich Center for Neutron Science 1 and Institute of Complex Systems 1
#    Jscatter is a program to read, analyse and plot data
#    Copyright (C) 2015  Ralf Biehl
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
from __future__ import division
from __future__ import print_function

"""
Some examples to show how to use Jscatter.

Functions show the code or run the examples in example directory.



"""

import os
import glob
import re
import platform
import subprocess
import tempfile
from .. import graceplot
from . import particlesWithInteraction

platformname = platform.uname()[0]

_path_ = os.path.realpath(os.path.dirname(__file__))
_expath = _path_
datapath = os.path.join(_expath, 'exampleData')


def _multiple_replace(string, rep_dict):
    # from https://stackoverflow.com/questions/6116978/how-to-replace-multiple-substrings-of-a-string
    pattern = re.compile("|".join([re.escape(k) for k in sorted(rep_dict, key=len, reverse=True)]), flags=re.DOTALL)
    return pattern.sub(lambda x: rep_dict[x.group(0)], string)


mplotreplace = {'.grace(': '.mplot(',
                '.plot(': '.Plot(',
                '.save(': '.Save(',
                '.xaxis(': '.Xaxis(',
                '.yaxis(': '.Yaxis(',
                '.legend(': '.Legend(',
                '.clear(': '.Clear(',
                '.title(': '.Title(',
                '.subtitle(': '.Subtitle(',
                '.multi(': '.Multi(',
                '.agr': '.png',
                '.text': '.Text',
                "(r'": "('",
                '.line': '.Arrow',
                r'\xp': 'pi', r'\N': '',
                'new_graph': 'Subplot',
                }


def _getexamples():
    exfiles = glob.glob(_expath + '/example_*.py')
    return sorted(exfiles)


[docs]def showExampleList(): """ Show a list of all examples. """ print('Example path : ', _expath) exfiles = _getexamples() for i, ff in enumerate(exfiles): print(i, ' ', os.path.basename(ff))
[docs]def runExample(example, usempl=False): """ Runs example Parameters ---------- example: string,int Filename or number of the example to run usempl : bool, default False For using mpl set to True """ if not graceplot.GraceIsInstalled: usempl = True if isinstance(example, int): exfiles = _getexamples() example = exfiles[example] sorted(example) print('-----------------------------------') print(example) cwd = os.getcwd() os.chdir(_expath) with open(example) as f: if usempl: if 'grace' in example or 'makeJ' in example: print('This example is not for mpl.') return file = f.read() exec(_multiple_replace(file, mplotreplace), {}) else: exec(f.read(), {}) os.chdir(cwd) return
[docs]def showExample(example='.', usempl=False): """ Opens example in default editor. Parameters ---------- example : string, int Filename or number. If '.' the folder with the examples is opened. usempl : bool, default False For using mpl set to True. Then mpl examples are shown. """ if not graceplot.GraceIsInstalled: usempl = True if isinstance(example, int): exfiles = _getexamples() example = exfiles[example] examplepath = os.path.join(_expath, example) if usempl: if 'grace' in example: print('This example is not for mpl.', example) return with tempfile.NamedTemporaryFile(suffix=".txt", prefix=example, delete=False) as tf: with open(examplepath) as f: file = f.read() newfile = _multiple_replace(file, mplotreplace) if platformname == 'Darwin': tf.write(newfile.encode()) tf.flush() examplepath = tf.name # open is broken but seem to be fixed in newest MACOS versions subprocess.call(('open',)) elif platformname == 'Windows': tf.write(newfile.replace('\n', '\r\n').encode()) tf.flush() examplepath = tf.name # noinspection PyUnresolvedReferences os.startfile(examplepath) else: tf.write(newfile.encode()) tf.flush() examplepath = tf.name subprocess.call(('xdg-open', examplepath)) tf.close() print(examplepath) else: print(examplepath) if platformname == 'Darwin': # open is broken but seem to be fixed in newest MACOS versions subprocess.call(('open',)) elif platformname == 'Windows': # This should not happen pass else: subprocess.call(('xdg-open', examplepath))
[docs]def runAll(start=None, end=None): """ Run all examples ( Maybe needs a bit of time ) . Parameters ---------- start,end : int First and last example to run """ exfiles = _getexamples() for ff in exfiles[start:end]: print('----------------------------------') print(os.path.basename(ff)) runExample(os.path.basename(ff))