From: Jean-Philippe ARGAUD Date: Sun, 15 Jan 2023 17:43:14 +0000 (+0100) Subject: Documentation update and simple plot support interface X-Git-Tag: V9_11_0a1~12 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=580702447a742595ae974b18786d160736d43e01;p=modules%2Fadao.git Documentation update and simple plot support interface --- diff --git a/doc/en/ref_algorithm_4DVAR.rst b/doc/en/ref_algorithm_4DVAR.rst index c337674..9b2a22c 100644 --- a/doc/en/ref_algorithm_4DVAR.rst +++ b/doc/en/ref_algorithm_4DVAR.rst @@ -28,9 +28,6 @@ Calculation algorithm "*4DVAR*" ------------------------------- -.. ------------------------------------ .. -.. include:: snippets/Header2Algo00.rst - .. ------------------------------------ .. .. include:: snippets/Header2Algo01.rst diff --git a/doc/en/ref_algorithm_DifferentialEvolution.rst b/doc/en/ref_algorithm_DifferentialEvolution.rst index 035f16c..d1f1b47 100644 --- a/doc/en/ref_algorithm_DifferentialEvolution.rst +++ b/doc/en/ref_algorithm_DifferentialEvolution.rst @@ -27,9 +27,6 @@ Calculation algorithm "*DifferentialEvolution*" ---------------------------------------------------- -.. ------------------------------------ .. -.. include:: snippets/Header2Algo00.rst - .. ------------------------------------ .. .. include:: snippets/Header2Algo01.rst diff --git a/doc/en/ref_algorithm_LocalSensitivityTest.rst b/doc/en/ref_algorithm_LocalSensitivityTest.rst index 7b79a15..fe63e2c 100644 --- a/doc/en/ref_algorithm_LocalSensitivityTest.rst +++ b/doc/en/ref_algorithm_LocalSensitivityTest.rst @@ -27,9 +27,6 @@ Checking algorithm "*LocalSensitivityTest*" ------------------------------------------- -.. ------------------------------------ .. -.. include:: snippets/Header2Algo00.rst - .. ------------------------------------ .. .. include:: snippets/Header2Algo01.rst diff --git a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst index 345c914..1f2fc20 100644 --- a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst +++ b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst @@ -25,6 +25,10 @@ .. index:: single: Optimal positioning of measurements .. index:: single: Measurement locations .. index:: single: Measurements (Optimal positioning) +.. index:: single: Ensemble of simulations +.. index:: single: Ensemble of snapshots +.. index:: single: Simulations (Ensemble) +.. index:: single: Snapshots (Ensemble) .. _section_ref_algorithm_MeasurementsOptimalPositioningTask: Task algorithm "*MeasurementsOptimalPositioningTask*" diff --git a/doc/en/ref_algorithm_ParallelFunctionTest.rst b/doc/en/ref_algorithm_ParallelFunctionTest.rst index ca1749b..701d06c 100644 --- a/doc/en/ref_algorithm_ParallelFunctionTest.rst +++ b/doc/en/ref_algorithm_ParallelFunctionTest.rst @@ -104,6 +104,7 @@ StoreSupplementaryCalculations .. include:: snippets/Header2Algo10.rst .. literalinclude:: scripts/simple_ParallelFunctionTest.res + :language: none .. ------------------------------------ .. .. include:: snippets/Header2Algo06.rst diff --git a/doc/fr/ref_algorithm_4DVAR.rst b/doc/fr/ref_algorithm_4DVAR.rst index 2a15456..f3d76f2 100644 --- a/doc/fr/ref_algorithm_4DVAR.rst +++ b/doc/fr/ref_algorithm_4DVAR.rst @@ -28,9 +28,6 @@ Algorithme de calcul "*4DVAR*" ------------------------------ -.. ------------------------------------ .. -.. include:: snippets/Header2Algo00.rst - .. ------------------------------------ .. .. include:: snippets/Header2Algo01.rst diff --git a/doc/fr/ref_algorithm_DifferentialEvolution.rst b/doc/fr/ref_algorithm_DifferentialEvolution.rst index 3d4277f..9ad239c 100644 --- a/doc/fr/ref_algorithm_DifferentialEvolution.rst +++ b/doc/fr/ref_algorithm_DifferentialEvolution.rst @@ -27,9 +27,6 @@ Algorithme de calcul "*DifferentialEvolution*" ---------------------------------------------- -.. ------------------------------------ .. -.. include:: snippets/Header2Algo00.rst - .. ------------------------------------ .. .. include:: snippets/Header2Algo01.rst diff --git a/doc/fr/ref_algorithm_LocalSensitivityTest.rst b/doc/fr/ref_algorithm_LocalSensitivityTest.rst index c5907c5..2506673 100644 --- a/doc/fr/ref_algorithm_LocalSensitivityTest.rst +++ b/doc/fr/ref_algorithm_LocalSensitivityTest.rst @@ -27,9 +27,6 @@ Algorithme de vérification "*LocalSensitivityTest*" --------------------------------------------------- -.. ------------------------------------ .. -.. include:: snippets/Header2Algo00.rst - .. ------------------------------------ .. .. include:: snippets/Header2Algo01.rst diff --git a/src/daComposant/daAlgorithms/MeasurementsOptimalPositioningTask.py b/src/daComposant/daAlgorithms/MeasurementsOptimalPositioningTask.py index 0a974c4..9e45bf6 100644 --- a/src/daComposant/daAlgorithms/MeasurementsOptimalPositioningTask.py +++ b/src/daComposant/daAlgorithms/MeasurementsOptimalPositioningTask.py @@ -127,6 +127,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): ) self.setAttributes(tags=( "Reduction", + "Checking", )) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daComposant/daNumerics/Gnuplot/ANNOUNCE.txt b/src/daComposant/daNumerics/Gnuplot/ANNOUNCE.txt new file mode 100644 index 0000000..f588210 --- /dev/null +++ b/src/daComposant/daNumerics/Gnuplot/ANNOUNCE.txt @@ -0,0 +1,83 @@ +This is to announce the release of version 1.8 of Gnuplot.py. + +Gnuplot.py is a Python [1] package that allows you to create graphs +from within Python using the gnuplot [2] plotting program. + +Gnuplot.py can be obtained from + + http://gnuplot-py.sourceforge.net/ + +Prerequisites (see footnotes): + the Python interpreter [1] + the Python numpy module [3] + the gnuplot program [2] + +or, to use it under Java (experimental): + a Java interpreter + the Jython interpreter [4] + the Jython version of the Numeric module [5] + the gnuplot program [2] + +Some ways this package can be used: + +1. Interactive data processing: Use Python's excellent numpy package + to create and manipulate arrays of numbers, and use Gnuplot.py to + visualize the results. +2. Web graphics: write CGI scripts in Python that use gnuplot to + output plots in (for example) PNG format and return them to the + client. +3. Glue for numerical applications (this is my favorite): wrap your + C++/C/Fortran subroutines so that they are callable from Python, + then you can perform numerical computations interactively from + scripts or from the command line and use Gnuplot.py to plot the + output on the fly. +4. Compute a series of datasets in Python and plot them one after the + other using Gnuplot.py to produce a crude animation. + +New features in this version: + + Various bug fixes + + an option "filename" to Data and GridDat + This allows saving the data to a permanent, rather than temporary + + pdf terminal definition + +Features already present in older versions: + + + Two and three-dimensional plots. + + Plot data from memory, from a file, or from an expression. + + Support for multiple simultaneous gnuplot sessions. + + Can pass arbitrary commands to the gnuplot program. + + Object oriented, extensible design with several built-in types + of plot items. + + Portable and easy to install (nothing to compile except on + Windows). + + Support for Unix (including Linux and Mac OS X), MS Windows, and + Mac OS. The platform-dependent layer is fairly well abstracted + out, so it shouldn't be too difficult to add support for other + platforms. + + Support for sending data to gnuplot as `inline' or `binary' data. + These are optimizations that also remove the need for temporary + files. + + Partly table-driven to make it easy to extend. New terminal + types can be supported easily by adding data to a table. + + Install via distutils. + + LGPL license . + + Support for sending data to gnuplot via FIFOs (named pipes, linux only). + + Preliminary support for running Gnuplot.py under Jython + +Footnotes: +---------- +[1] Python is an excellent object-oriented + scripting/rapid development language that is also especially good + at gluing programs together. +[2] gnuplot is a free, popular, very + portable plotting program with a command-line interface. It can + make 2-d and 3-d plots and can output to myriad printers and + graphics terminals. +[3] The numpy Python extension is a + Python module that adds fast and convenient array manipulations to + the Python language. +[4] Jython is a Python interpreter that runs + within a Java virtual machine. +[5] JNumeric is a version of the + Numeric module that runs under Java/Jython. + diff --git a/src/daComposant/daNumerics/Gnuplot/CREDITS.txt b/src/daComposant/daNumerics/Gnuplot/CREDITS.txt new file mode 100644 index 0000000..7b3444a --- /dev/null +++ b/src/daComposant/daNumerics/Gnuplot/CREDITS.txt @@ -0,0 +1,47 @@ +CREDITS: + +Gnuplot.py was written by Michael Haggerty , +inspired by and partly derived from an earlier version by Konrad +Hinsen. I maintain it and continue to develop it, though by now it +has most of the features that I had planned for it. + +I would like to acknowledge and express my appreciation to the +following people for their contributions: + +Konrad Hinsen wrote the first, procedural +interface version of Gnuplot.py. His code is still present in many +components of the current version. The oldplot.py module, which used +to be included in Gnuplot.py for backwards compatibility with his +version, hasn't been supported for a while so I deleted it. + +Berthold Hoellmann introduced me to the +helpful `pythondoc' package, and contributed some docstring changes to +allow web documentation to be generated from the Gnuplot.py source. +He also submitted a setup.py file to be used with Python distutils. + +Craig Schardt and Francois Ladouceur + contributed changes to enable +Gnuplot.py to work under MS-Windows. + +Tony Ingraldi got Gnuplot.py to work on +the Macintosh and Noburu Yamamoto also contributed to this code. + +Stuard Reynolds made some helpful +suggestions for automating the tabulation of function values. + +Jannie Hofmeyr suggested using "from os import +popen" in gp_win32.py for versions of Python subsequent to 2.0. + +Daehyok Shin pointed out that support for the +`axes' keyword was missing. + +Jon Moody suggested some changes for Mac OS. + +Andy Main contributed terminal_opts for metapost output. + +Matthew Fulmer contributed a patch to add the "filename" argument to +Data and GridData. + +Benny Malengier will push out new versions if the need arises starting +from 1.8 + diff --git a/src/daComposant/daNumerics/Gnuplot/Errors.py b/src/daComposant/daNumerics/Gnuplot/Errors.py new file mode 100644 index 0000000..53731f8 --- /dev/null +++ b/src/daComposant/daNumerics/Gnuplot/Errors.py @@ -0,0 +1,25 @@ +# Id: Errors.py 244 2003-04-21 09:44:09Z mhagger + +# Copyright (C) 2001-2003 Michael Haggerty +# +# This file is licensed under the GNU Lesser General Public License +# (LGPL). See LICENSE.txt for details. + +"""Exception types that can be raised by Gnuplot.py.""" + + +class Error(Exception): + """All our exceptions are derived from this one.""" + pass + + +class OptionError(Error): + """Raised for unrecognized option(s)""" + pass + + +class DataError(Error): + """Raised for data in the wrong format""" + pass + + diff --git a/src/daComposant/daNumerics/Gnuplot/FAQ.txt b/src/daComposant/daNumerics/Gnuplot/FAQ.txt new file mode 100644 index 0000000..14f465e --- /dev/null +++ b/src/daComposant/daNumerics/Gnuplot/FAQ.txt @@ -0,0 +1,147 @@ +# Id: FAQ.txt 294 2006-11-07 02:33:08Z parejkoj + +Frequently Asked Questions + +This file is meant to answer the most frequently asked questions about +the Gnuplot.py package. If you want to suggest additional questions +(with or without answers!) please mail them to the Gnuplot.py users +mailing list, . + +====================================================================== + +Q1: + +When running the following script + +------------------------------------------------ +#! /usr/bin/python2 + +import Gnuplot, Gnuplot.funcutils +from numpy import * + +g = Gnuplot.Gnuplot() +g.plot([[0,1.1], [1,5.8], [2,3.3], [3,4.2]]) +------------------------------------------------ + +I get the error + + gnuplot> plot '/tmp/@24463.2' + ^ + can't read data file "/tmp/@24463.2" + line 0: (No such file or directory) + +However, the same commands work fine if I type them into the +interpreter! What's wrong? + +A1: + +The problem is that in many cases Gnuplot.py sends data to gnuplot via +a temporary file. But Gnuplot.py has no way of knowing when it is +safe to delete the temporary file. So it deletes it when the +corresponding PlotItem object is deleted, which is typically when the +next Gnuplot.plot() command is executed or when the python script +ends. (Until you plot something else, the Gnuplot object keeps a +reference to all of the old plot items to prevent their being garbage +collected.) + +To prevent this problem, there are several possibilities: + +1. Switch to Unix. On that platform, Gnuplot.py now uses FIFOs (named + pipes) by default to send data to gnuplot. This seems to provide a + robust and somewhat elegant solution to this problem. + +2. Use "inline data" instead of temporary files to communicate with + gnuplot. This is already available in gnuplot for most plotting + modes if you specify the "inline=1" option to the constructor of + the Data object, or if you set GnuplotOpts.prefer_inline_data=1. + Since inline data doesn't involve temporary files, the problem goes + away. + +3. Introduce a delay between the time you plot and the time you allow + the Data object to be deleted. You could just use time.sleep(), or + if you are producing a graphics file you might watch for the + creation of the output file and at that point assume that gnuplot + is done with the temporary file. One idea is to explicitly create + a PlotItem to represent the data, and keep a reference to the + PlotItem for some time after the plot() command is executed; e.g., + + data = Gnuplot.Data([[0,1.1], [1,5.8], [2,3.3], [3,4.2]]) + g.plot(data) + # ... do something guaranteed to last a couple seconds + del data # temporary file is deleted at this moment + +4. Change Gnuplot.py itself to implement two-way communication between + gnuplot and Gnuplot.py. Then, for example, Gnuplot.py could delete + temporary files when the next gnuplot prompt appears. This would + be a lot of work but it would allow other new features such as + detecting gnuplot errors, reading gnuplot fit command output back + to python, etc. + +====================================================================== + +Q2: + +Does Gnuplot.py work under Jython/Java? + +A2: + +Partly. Version 1.7 added the low-level interface gp_java.py for +communicating with gnuplot using the Java libraries, and that part +seems to work. + +However, Gnuplot.py relies on the Python Numeric library, which is a C +library. The Jython equivalent, called JNumeric +, therefore has to be installed. +However, JNumeric is still at beta level, and operation under Jython +hasn't been tested much at all, so feedback is welcome! + +====================================================================== + +Q3: + +[from Tate Wilson] + +I am trying to set up your gnuplot/python package on my mac (osX). +The readme file says I need to convert the files to mac text files. +The coverter I usually use, maclink, won't handle these files. Can +you give me a hint how to convert the files or where to look for help? + +A3: + +I don't know. But the same user later reported what worked for him: + +I did have to convert the files. It may not be true for all mac +Python users, but I suspect it is. I'm using a graphical Python +development environment called "Python IDE for mac" which may have its +own pickiness, but still, it wouldn't even recognize the files in your +package as being the type it could open. I tried a few different file +converters with no luck. Then I just opened all the files with +BBedit, changed something so I would be prompted to save it on closing +(like add and remove a letter), and closed BBedit. Then all the files +were 'mac' files and the Python interpreter recognised them. + +====================================================================== + +Q4: + +I am using Windows and I get an error like + +> Traceback (most recent call last): +> [...] +> File "C:\Python23\Lib\site-packages\Gnuplot\gp_win32.py", +> line 125, in __call__ +> self.write(s + '\n') +> IOError: [Errno 22] Invalid argument + +What is the problem? + +A4: + +This is apparently the error that results when Gnuplot.py cannot start +the pgnuplot.exe executable under Windows. It could be that gnuplot +(the plotting program, as opposed to Gnuplot.py) is not installed, or +that it is not in your PATH. If your pgnuplot.exe executable is named +differently, or you do not want to add its directory to your PATH, you +can change gnuplot_command in gp_win32.py to indicate the precise path +to the executable. + diff --git a/src/daComposant/daNumerics/Gnuplot/LICENSE.txt b/src/daComposant/daNumerics/Gnuplot/LICENSE.txt new file mode 100644 index 0000000..b1e3f5a --- /dev/null +++ b/src/daComposant/daNumerics/Gnuplot/LICENSE.txt @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/src/daComposant/daNumerics/Gnuplot/NEWS.txt b/src/daComposant/daNumerics/Gnuplot/NEWS.txt new file mode 100644 index 0000000..c864549 --- /dev/null +++ b/src/daComposant/daNumerics/Gnuplot/NEWS.txt @@ -0,0 +1,258 @@ +Id: NEWS.txt 302 2008-01-14 22:15:19Z bmcage + +This file describes the changes introduced in each version of the +Gnuplot.py package. + +Version ?.? + +Version 1.8: + +* hardcopy allows for terminal='svg' (using a patch from Spyros Blanas) + +* Use with_ instead of with as that will be a python keyword in the + future. + +* Added an option "filename" to Data and GridData in PlotItems.py. + This allows saving the data to a permanent, rather than temporary, + file. (Patch contributed by Matthew Fulmer.) + +* Added a 'pdf' terminal definition (using a patch from Jim Kleckner). + +* Added close() and __del__() methods to the Gnuplot class. This + might help with some cases of premature temporary file deletion. + (Suggested by Jim Kleckner.) + + +Version 1.7: + +* Relaxed license from GPL to LGPL. + +* Significant reorganization of PlotItem.py: + + + Deleted the AnyFile classes from PlotItem: AnyFile, TempFile, + ArrayFile, and TempArrayFile. Those classes weren't pulling their + weight. + + + Added a new _FileItem class to represent all forms of data that + gnuplot treats as a file. + + + Added a new _TempFileItem class to represent PlotItems that are + based on a temporary file. + + + Added a new _InlineFileItem class to represent PlotItems whose + data is passed to gnuplot inline. + + + Changed PlotItems.File() and PlotItems.Data from classes into + factory functions that produce instances of the classes mentioned + above. + +* Slightly changed the PlotItem interface to support the new derived + classes: + + + Removed the basecommand argument to the constructor. Instead + added a get_base_command_string() method to retrieve that string. + This function is not defined in PlotItem so it is added to the + derived classes. (This function is used by _FIFOFileItem as the + hook where _FIFOWriters are created. + + + Added a new get_command_option_string() method which abstracts out + the construction of the option part of the command() method. + +* Added support for sending data to gnuplot via FIFOs (named pipes) + via a new _FIFOFileItem class. This mechanism removes the ambiguity + about when temporary files should be deleted, therefore making it + easier to use Gnuplot.py in script environments, etc. This feature + is only implemented under *nix because Python doesn't implement the + required threading module and os.mkfifo() on other operating + systems. Added two new configuration options, support_fifo and + prefer_fifo_data, to the gp_*.py files to switch the new feature on + and off. + +* Started adding support for running Gnuplot.py under Jython/Java. + Added gp_java.py, which is a functioning low-level interface to + gnuplot via java.lang.Process objects. The rest might work, too, if + you have JNumeric installed. + (Gnuplot.py relies on the Numeric library; JNumeric is the Jython + equivalent.) If I find the time I might try to produce a version + that doesn't require Numeric at all, under either Python or Jython. + +* Removed the oldplot.py module: (1) I doubt anybody is still using + it. (2) It seems to be broken anyway. (3) I don't have the energy to + fix or maintain it. Let me know if I'm wrong about point 1. + +* Started a new FAQ.txt file and added an answer to the single most + frequently asked question. + + +Version 1.6: + +* Introduced a general mechanism to make it easy to support multiple + gnuplot terminal types in the Gnuplot.hardcopy() function. Added + definitions for 'postscript', 'png', 'fig', and 'cgm'. Other + terminal types can now be added easily. + +* Changed names of Exceptions to be more consistent with other + modules: OptionException -> OptionError and DataException -> + DataError. Moved both to Errors.py and derive both from + Errors.Error. + +* Incorporated several changes for Mac OS suggested by Jon Moody. + +* Added a gp_macosx.py file to support Mac OS X. The only difference + between this and gp_unix.py is the default terminal selection. + +* Moved import statement in demo.py to global scope for Python 2.2. + +* Removed claims that demo.py can be run before installing Gnuplot.py. + + +Version 1.5: + +* Broke up the module a bit for better maintainability. The most + commonly-used facilities are still available through "import + Gnuplot", but a few more specialized things have been moved to + separate modules, in particular funcutils.py and PlotItems.py. + __init__.py now just imports things from other modules. + +* funcutils.tabulate_function() can be used to evaluate a function + on a 1-D or 2-D grid of points (this replaces grid_function, + which only worked with 2-D grids). + +* Added two helper functions, funcutils.compute_Data and + funcutils.compute_GridData, which compute a function's values on + a set of points and package the results into a PlotItem. + +* GridFunc is no longer an independent class; it is now a factory + function that returns a GridData. GridFunc is deprecated in + favor of funcutils.compute_GridData. + +* Changed set_option to work from a table, so that it doesn't need to + be overloaded so often. + +* Made changes like those submitted by Matthew Martin + to allow the `smooth' option. + +* Implemented test_persist for each platform to make it easier for + users to determine whether the `-persist' option is supported. + +* Added a prefer_persist option to serve as the default `persist' + choice. + +* Following a suggestion by Jannie Hofmeyr , use + "from os import popen" for Python 2.0 under Windows. I don't use + Windows, so let me know how this works. + +* Added a setup.py file so that Gnuplot.py can be installed using + Python distutils. + +* Added support for the `axes' parameter of the `plot' command. + +* Reworked the comment strings in an effort to make them work nicely + with happydoc. + + +Version 1.4: + +* Added support for the Macintosh, thanks to help from Tony Ingraldi. + +* Split the platform-dependent code, including the configuration + options, into separate modules: gp.py, gp_mac.py, and gp_win32.py. + The GnuplotProcess class defined in those files is a lightweight + interface to the gnuplot program that could also conceivably be + useful to somebody. + +* Allow access to all of the postscript printer driver options through + the hardcopy() method. + +* Fixed an import problem in test.py. + + +Version 1.3: + +* Converted to package format. The main file is now called + __init__.py, so that it can be loaded by typing 'import Gnuplot'. + +* Passing GridData a callable function was basically broken because of + the kludgey way of overloading the argument. Instead of trying to + fix it, I moved that functionality to a new type of PlotItem + called 'GridFunc'. + +* Added a new keyword argument, 'ufunc', to grid_function and to + GridFunc. If that argument is nonzero, then the function is + evaluated matrix-wise (in that case it must be composed only of + ufunctions or ufunction-like routines). + +* Fixed a 'typecode' problem with grid_function (typecode is + apparently a positional, not a keyword, argument in the Numeric + library). + +* Separated the demonstration code into a separate file, demo.py, to + shorten __init__.py a bit. + + +Version 1.2 (8 Aug 1999): + +* Support for MS Windows, using the `pgnuplot.exe' program. + Thanks go especially to Craig Schardt for help with this. + +* Support for using binary files to send grid data to splot. + This saves a lot of time and usually saves space compared with + the old text files. (Only works with recent versions of + gnuplot.) + +* Support for sending data to gnuplot as `inline data' (i.e., "plot + '-'"). This method should be faster than the alternate method, + temporary files. (Only works with recent versions of gnuplot.) + +* Allows PlotItem options to be modified after the PlotItem is + constructed. + +* Simplified the PlotItem inheritance hierarchy (Data and GridData are + no longer derived from File). + +* Added several configuration options (see top of Gnuplot.py). + +* Separated function-based interface into a separate file + (Gnuplot_plot.py). + +* Added a test module, Gnuplot_test.py, which tests most of the + features of Gnuplot.py. + +* A README file, lots of documentation changes, etc. + + +Version 1.1a (9 Apr 1999): + +This version just addresses a couple of minor portability issues. + + +Version 1.1 (31 Jan 1999): + +* 3-D plots are now supported through the new 'splot' method: + + To create a scatter plot, pass splot a 2-D array containing + (x,y,z) triplets; + + To create a grid plot, pass a 3-D array consisting of a 2-D array + of (x,y,z) triplets; or + + Use the new `GridData' PlotItem to plot gridded data (data + tabulated on a rectangular grid). + +* It is now easier to pass data to gnuplot. The 'Data' PlotItem now + accepts multiple arguments representing subsequent 'columns' of the + dataset; e.g., what used to be written as + + g = Gnuplot.Gnuplot() + x = numpy.arange(100)/10.0 + y = x**2 + # Create an array of (x,y) pairs: + g.plot(Gnuplot.Data(numpy.transpose((x, y)))) + + can now be shortened to + + # Plot y vs. x directly: + g.plot(Gnuplot.Data(x, y)) + + (both examples plot x squared vs. x). Similarly, splot can be + passed three arrays representing the values of x, y, and z. + Note that the old interpretation is still used if a single + argument is passed to `Data'. + diff --git a/src/daComposant/daNumerics/Gnuplot/PlotItems.py b/src/daComposant/daNumerics/Gnuplot/PlotItems.py new file mode 100644 index 0000000..f6ef547 --- /dev/null +++ b/src/daComposant/daNumerics/Gnuplot/PlotItems.py @@ -0,0 +1,751 @@ +# Id: PlotItems.py 299 2007-03-30 12:52:17Z mhagger + +# Copyright (C) 1998-2003 Michael Haggerty +# +# This file is licensed under the GNU Lesser General Public License +# (LGPL). See LICENSE.txt for details. + +"""PlotItems.py -- Objects that can be plotted by Gnuplot. + +This module contains several types of PlotItems. PlotItems can be +plotted by passing them to a Gnuplot.Gnuplot object. You can derive +your own classes from the PlotItem hierarchy to customize their +behavior. + +""" + +import os, string, tempfile, types + +from io import StringIO + +import numpy + +import gp +import Gnuplot.Errors as Errors +import Gnuplot.utils as utils + + +class _unset: + """Used to represent unset keyword arguments.""" + + pass + + +class PlotItem: + """Plotitem represents an item that can be plotted by gnuplot. + + For the finest control over the output, you can create 'PlotItems' + yourself with additional keyword options, or derive new classes + from 'PlotItem'. + + The handling of options is complicated by the attempt to allow + options and their setting mechanism to be inherited conveniently. + Note first that there are some options that can only be set in the + constructor then never modified, and others that can be set in the + constructor and/or modified using the 'set_option()' member + function. The former are always processed within '__init__'. The + latter are always processed within 'set_option', which is called + by the constructor. + + 'set_option' is driven by a class-wide dictionary called + '_option_list', which is a mapping '{