Python Shell Gnuplot
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
doc
gnuplot
test/gnuplot
.gitignore
CHANGES.txt
README.rst
SConstruct

README.rst

scons-tool-gnuplot

Gnuplot tool for scons. For tarball and documentation see project page at sourceforge.net.

INSTALLATION

Copy the gnuplot/ directory to your project's site_scons/site_tools/ or to ~/.scons/site_scons/site_tools/ (per user configuration). See SCons manual for details.

REQUIREMENTS

To perform certain activities, you may need the following packages (listed per task).

TO DOWNLOAD DEPENDENCIES FROM EXTERNAL REPOSITORIES

Sometimes it may be necessary to download files from other people's repositories, for example test framework is necessary to run tests. We have some scripts to automatize the download process, and they require the following software

TO RUN TESTS

  • scons test framework, that is QMTest directory and runtests.py script,

TO GENERATE API DOCUMENTATION

TO GENERATE USER DOCUMENTATION

and (locally downloaded)

ADDITIONAL STEPS

If this is a fresh clone/checkout from repository, you may wish to perform a few additional steps as below (this is mainly for gnuplot tool developers and package maintainers)

DOWNLOAD DEPENDENCIES FROM EXTERNAL REPOSITORIES

Some files from external projects need to be downloaded into the development tree (they are usually not a part of any installable package). The files are obtainable from external repositories, and may be easily downloaded on GNU systems with the script bin/download-deps.sh

bin/download-deps.sh

The development tree may be later cleaned-up from the downloaded files by:

bin/delete-deps.sh

Particular projects, that this project depends on, are mentioned in the following subsections. You may look through it if the above scripts do not work well on your platform. Otherwise, all of the following dependencies are handled by download-deps.sh and delete-deps.sh scripts.

All downloaded files are ignored by .gitignore, so you don't have to worry about deleting them before doing commits.

TESTING FRAMEWORK

If you wish to run end-to-end tests for this tool, you need the scons testing framework. The following files/directories need to be downloaded (and placed as shown in table relative to the top-level source directory)

source file/directory target file/directory
QMTest/ QMTest/
runtest.py runtest.py

On GNU system you may use the bin/download-test-framework.sh script to download the above files (requires curl to be installed on your system):

bin/download-test-framework.sh

This script clones the scons repository to a temporary directory and copies the QMTest subdirectory and runtest.py script from the repository to the local source tree. The test framework may be later removed with the bin/delete-test-framework.sh script:

bin/delete-test-framework.sh

You may also delete manually files/directories comprising the framework.

SCONS DOCBOOK TOOL

If you wish to generate user's guide, you need to download locally the scons docbook tool. It is obtainable from Dirk Baechle's repository hosted on bitbucket.org. The following files/directories need to be downloaded (and placed as shown in table relative to the top-level source directory)

source file/directory target file/directory
__init__.py site_scons/site_tools/docbook/__init__.py
utils/ site_scons/site_tools/docbook/utils
docbook-xsl-<ver>/ site_scons/site_tools/docbook/docbook-xsl-<ver>

On GNU system you may use the bin/download-docbook-tool.sh script to download the docbook tool (requires curl to be installed on your system):

bin/download-docbook-tool.sh

The tool may be later removed with the bin/delete-docbook-tool.sh script:

bin/delete-test-framework.sh

You may also delete manually files/directories comprising the tool package.

RUNNING TESTS

To run all the tests type:

SCONS_EXTERNAL_TEST=1 python runtest.py -a

This requires the presence of the testing framework in the development tree.

GENERATING DOCUMENTATION

Scons gnuplot tool has an API documentation and user manual. The documentation may be generated as follows (see also REQUIREMENTS).

API DOCUMENTATION

To generate API documentation type:

scons api-doc

The generated API documentation will be written to build/doc/api/.

USER MANUAL

To generate user manual type:

scons user-doc

The generated documentation will be written to build/doc/user/.

LICENSE

Copyright (c) 2013 by Pawel Tomulik

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE