Author: bugman
Date: Mon Sep 8 20:39:52 2014
New Revision: 25704
URL: http://svn.gna.org/viewcvs/relax?rev=25704&view=rev
Log:
Changed the organisation of the files in the docs/ directory.
A new docs/devel directory has been created and the 2to3_checklist,
Mac_framework_build_3way,
package_layout, and prompt_screenshot.txt documents shifted into it. This is
to hide or abstract
away the development documents so that relax users do not see them when
looking into docs/. This
should make the directory less intimidating.
Added:
trunk/docs/devel/
trunk/docs/devel/2to3_checklist
- copied unchanged from r25700, trunk/docs/2to3_checklist
trunk/docs/devel/Mac_framework_build_3way
- copied unchanged from r25700, trunk/docs/Mac_framework_build_3way
trunk/docs/devel/package_layout
- copied unchanged from r25700, trunk/docs/package_layout
trunk/docs/devel/prompt_screenshot.txt
- copied unchanged from r25700, trunk/docs/prompt_screenshot.txt
Removed:
trunk/docs/2to3_checklist
trunk/docs/Mac_framework_build_3way
trunk/docs/package_layout
trunk/docs/prompt_screenshot.txt
Removed: trunk/docs/2to3_checklist
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/2to3_checklist?rev=25703&view=auto
==============================================================================
--- trunk/docs/2to3_checklist (original)
+++ trunk/docs/2to3_checklist (removed)
@@ -1,99 +0,0 @@
-The following is a checklist for the migration from Python 2.x to Python
3.x. Only changes which allow relax to run on both versions will currently
be applied. This is performed by the 2to3 program that comes with Python 3.x
and the syntax used is:
-
-2to3 -w . -f xxx
-
-where xxx is the transformation being applied.
-
-
-Key
-~~~
-
-+ committed.
-! deadly for python 2.x.
-~ nothing to do.
-
-
-The transformations
-~~~~~~~~~~~~~~~~~~~
-
-~apply
-~basestring
-~buffer
-~callable
-+dict
-!except
-+exec
-+execfile
-~filter
-~funcattrs
-~future
-~getcwdu
-+has_key
-+idioms
-!import
-!imports
-~imports2
-~input
-~intern
-~isinstance
-~itertools
-~itertools_imports
-!long # This kills the method used for sanely stopping a ridiculous grid
search.
-~map
-~metaclass
-~methodattrs
-~ne
-~next
-~nonzero
-!numliterals
-~paren
-+print
-+raise
-~raw_input
-~reduce
-~renames
-+repr
-~set_literal
-~standarderror
-~sys_exc
-~throw
-~tuple_params
-~types
-~unicode
-~urllib
-+ws_comma
-!xrange # This will cause memory problems in certain parts of relax.
-~xreadlines
-~zip
-
-
-Non-dangerous 3.0 update command
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This needs to be carefully checked before committing.
-
-2to3 -j 4 -w \
--f buffer \
--f idioms \
--f set_literal \
--f ws_comma \
--x except \
--x import \
--x imports \
--x long \
--x numliterals \
--x xrange \
-.
-
-
-Deadly 3.0 update command
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-2to3 -j 4 -w \
--f except \
--f import \
--f imports \
--f long \
--f numliterals \
--f xrange \
-.
Removed: trunk/docs/Mac_framework_build_3way
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/Mac_framework_build_3way?rev=25703&view=auto
==============================================================================
--- trunk/docs/Mac_framework_build_3way (original)
+++ trunk/docs/Mac_framework_build_3way (removed)
@@ -1,158 +0,0 @@
-This is a set of instructions on how to set up a 3-way (i386, pcc, x86_64)
Python development framework for Mac OS X. This requires Xcode to be
installed.
-
-
-# Python.
-
-Unpack Python 2.7, and then run:
-
-$ ./configure --prefix=$HOME
--enable-universalsdk=/Developer/SDKs/MacOSX10.5.sdk
--with-universal-archs=3-way --enable-framework=$HOME/Library/Frameworks
-$ make
-$ make install
-
-This will put the Python installation into
~/Library/Frameworks/Python.framework/Versions/2.7/ and the binaries will be
symlinked in ~/bin. Therefore add ~/bin to the system path by adding the
following to .bash_profile:
-
-PATH=$PATH:$HOME/bin
-export PATH
-
-Check the Python Framework 3-way architecture using the
devel_scripts/framework_bin_test script. The Tk module might fail as the
10.5 Mac SDK could be only i386 and ppc build. Then a custom Tcl/Tk build
will be required (e.g. at http://cran.r-project.org/bin/macosx/tools/) and
the tkinter module build by hand, changing the -isysroot flag to / at the
last step.
-
-
-
-# Numpy.
-
-Unpack numpy, and then run:
-
-$ ~/bin/python2.7 setup.py install
-
-This should take the deployment target platform, the architectures, etc.
from the Python install.
-
-
-
-# Scipy.
-
-Install the appropriate GNU fortran version to add to Xcode (for example
gfortran-42-5664.pkg from http://r.research.att.com/tools/). Xcode does not
come with a Fortran compiler and the fink version will not be able to create
Universal 3-way binaries.
-
-$ PATH=/usr/local/bin/:$PATH C_INCLUDE_PATH=/sw/include/suitesparse/
~/bin/python2.7 setup.py install
-
-The PATH option is needed if gfortran is located in both /usr/local/bin/ and
/sw/bin/. The C_INCLUDE_PATH may be needed if the suitesparse header files
cannot be found. If you still encounter swig problems finding the
umfpack_*.h files, then manually type:
-
-$ swig -I/sw/include/suitesparse/ -python -o
build/src.macosx-10.5-fat3-2.7/scipy/sparse/linalg/dsolve/umfpack/_umfpack_wrap.c
-outdir build/src.macosx-10.5-fat3-2.7/scipy/sparse/linalg/dsolve/umfpack
scipy/sparse/linalg/dsolve/umfpack/umfpack.i
-$ PATH=/usr/local/bin/:$PATH C_INCLUDE_PATH=/sw/include/suitesparse/
~/bin/python2.7 setup.py install
-
-The swig command will build the Scipy part requining the umfpack_*.h files,
and then the python command will continue happily.
-
-
-
-# Nose.
-
-This is needed for numpy and scipy testing via the numpy.test() and
scipy.test() functions. Download the latest version from
https://pypi.python.org/pypi/nose, unpack it and type:
-
-$ ~/bin/python2.7 setup.py install
-
-Do not use pip or easy_install!
-
-
-
-# Mpi4py.
-
-The deployment target platform, SDK root, and the architectures need to be
set explicitly with environmental variables:
-
-$ export MACOSX_DEPLOYMENT_TARGET='10.5'
-$ export SDKROOT='/Developer/SDKs/MacOSX10.5.sdk'
-$ export ARCHFLAGS='-arch i386 -arch x86_64 -arch ppc'
-
-This is probably because mpicc is dumber than gcc! Make sure that there is
no 'build' directory prior to compilation. Finally, run:
-
-$ PATH=/usr/bin/:$PATH ~/bin/python2.7 setup.py install
-
-The PATH change is required here just in case the non-framework Fink mpicc
compiler is installed.
-
-
-
-# wxPython 2.8.
-
-Download and unpack the latest source release. Create a build directory
inside the unpacked sources and configure with:
-
-$ mkdir bld
-$ cd bld
-#$ export arch_flags="-arch i386 -arch ppc -arch x86_64"
-$ ../configure --prefix=$HOME \
- --with-mac \
- --with-opengl \
- --enable-debug \
- --enable-debug_gdb \
- --enable-geometry \
- --enable-graphics_ctx \
- --enable-sound --with-sdl \
- --enable-mediactrl \
- --enable-display \
- --enable-monolithic \
- --enable-unicode \
- --enable-universal_binary \
- --with-libjpeg=builtin \
- --with-libpng=builtin \
- --with-libtiff=builtin \
- --with-zlib=builtin \
- --with-macosx-sdk=/Developer/SDKs/MacOSX10.5.sdk \
- #--enable-framework=$HOME/Library/Frameworks \
- #CFLAGS='$arch_flags' \
- #CXXFLAGS='$arch_flags' \
- #CPPFLAGS='$arch_flags' \
- #LDFLAGS='$arch_flags' \
- #OBJCFLAGS='$arch_flags' \
- #OBJCXXFLAGS='$arch_flags'
-
-Create an executable file in the 'bld' directory called '.make'. Add the
following text to the file:
-
-make $* \
- && make -C contrib/src/gizmos $* \
- && make -C contrib/src/stc $*
-
-
-
-# wxPython >= 2.9.
-
-Download and unpack the latest source release. In the base directory, type:
-
-$ cd wxPython
-$ ~/bin/python2.7 build-wxpython.py --build_dir=../bld --osx_cocoa
--mac_universal_binary --prefix=$HOME --unicode --install
-
-
-
-# SCons.
-
-Download and unpack the latest release, then type:
-
-$ ~/bin/python2.7 setup.py install
-$ cd ~/bin
-$ ln -s
/Users/edward/Library/Frameworks/Python.framework/Versions/2.7/bin/scons scons
-
-Then edit the scons file and change the top of the file from:
-
-#! /usr/bin/env python
-#
-# SCons - a Software Constructor
-#
-
-To:
-
-#! /Users/edward/bin/python
-#
-# SCons - a Software Constructor
-#
-
-
-
-# Py2app.
-
-This is needed to create the universal binary DMG distribution file.
Download the latest version from https://pypi.python.org/pypi/py2app/. Then
open it and:
-
-$ ~/bin/python2.7 setup.py install
-
-
-
-# Matplotlib.
-
-This might be used more in relax in the future. Download the latest version
and then:
-
-$ ~/bin/python2.7 setup.py install
Removed: trunk/docs/package_layout
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/package_layout?rev=25703&view=auto
==============================================================================
--- trunk/docs/package_layout (original)
+++ trunk/docs/package_layout (removed)
@@ -1,57 +0,0 @@
-
-
-Directory layout design (2013-03-01)
-====================================
-
-The following is an idea for how to lay out the directories for the relax
sources. The changes suggested must occur after the merging of the
frame_order_testing branch.
-
-____________________________________________________________________________________________________
-
-Package Description
-____________________________________________________________________________________________________
-
-auto_analyses Unchanged from now. A collection of massive relax
scripts used to simplify the
- life of relax users.
-
-data_store The relax data store and all modules which operate on it
(data and generic_fns).
-
-extern GPL compatible packages bundled with relax.
-
-graphics Mainly a repository for all bitmap and vector graphics,
but a few auxiliary
- functions for handling graphics within relax (e.g. icons
in the GUI).
-
-gui The graphical UI.
-
-lib A set of modules and functions independent of the relax
data store and specific
- analyses. Half of maths_fns and some of generic_fns.
No code is allowed to
- reference the data store!
-
-lib.frame_order Most of the modules of maths_fns.frame_order.
-
-lib.geometry To include, for example, maths_fns.rotation_matrix.
-
-lib.opendx From opendx.
-
-lib.alignment For example maths_fns.rdc, math_fns.pcs, etc.
-
-lib.structure From generic_fns.structure.
-
-multi The multi-processor code.
-
-pipe_control All modules which are used to manage data in the relax
data pipes. This is most of generic_fns.
-
-prompt The prompt/script UI.
-
-scons The SCons modules.
-
-specific_analyses Analysis specific code (currently called specific_fns).
-
-target_functions A collection of all the target functions. This is most
of the current
- maths_fns. The modules contain target function classes
which must present the
- func() method as the target function (and the optional
dfunc() and d2func() for
- the gradient and Hessian respectively).
-
-test_suite The relax test suite.
-
-user_functions The definitions of the relax user functions.
-____________________________________________________________________________________________________
Removed: trunk/docs/prompt_screenshot.txt
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/prompt_screenshot.txt?rev=25703&view=auto
==============================================================================
--- trunk/docs/prompt_screenshot.txt (original)
+++ trunk/docs/prompt_screenshot.txt (removed)
@@ -1,7 +0,0 @@
-help
-pipe.create('test', 'mf')
-pipe.create('noe test', 'noe')
-pipe.display()
-minimise.execute()
-reset()
-state.load('results')
r25704 - in /trunk/docs: ./ devel/