Changes in / [2d707e3:22d92da] in sasview


Ignore:
Files:
1 deleted
8 edited

Legend:

Unmodified
Added
Removed
  • docs/sphinx-docs/build_sphinx.py

    r2fb09c4 r9bf64f6  
    2727SASVIEW_BUILD = os.path.abspath(os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "build", "lib"+platform)) 
    2828SASVIEW_DOCS = os.path.join(SASVIEW_BUILD, "doc") 
    29 SASVIEW_TEST = os.path.join(SASVIEW_SRC, "..", "sasview", "test", "media") 
    3029 
    3130SPHINX_BUILD = os.path.join(CURRENT_SCRIPT_DIR, "build") 
     
    3534SPHINX_SOURCE_MODELS = os.path.join(SPHINX_SOURCE, "user", "models") 
    3635SPHINX_SOURCE_PERSPECTIVES = os.path.join(SPHINX_SOURCE, "user", "perspectives") 
    37 SPHINX_SOURCE_TEST = os.path.join(SPHINX_SOURCE, "test") 
    3836 
    3937BUMPS_DOCS = os.path.join(CURRENT_SCRIPT_DIR, "..", "..", "..", 
     
    5755    _remove_dir(SPHINX_SOURCE_MODELS) 
    5856    _remove_dir(SPHINX_SOURCE_PERSPECTIVES) 
    59     _remove_dir(SPHINX_SOURCE_TEST) 
    6057 
    6158def retrieve_user_docs(): 
     
    9087 
    9188            copy_tree(docs, dest_dir) 
    92              
    93     # Now pickup testdata_help.rst 
    94 #    print os.path.abspath(SASVIEW_TEST) 
    95 #    print os.path.abspath(SPHINX_SOURCE_TEST) 
    96     if os.path.exists(SASVIEW_TEST): 
    97        print "Found docs folder at ", SASVIEW_TEST 
    98        shutil.copytree(SASVIEW_TEST, SPHINX_SOURCE_TEST)        
    9989 
    10090def retrieve_bumps_docs(): 
  • docs/sphinx-docs/source/user/user.rst

    rb69edaa r28812b8  
    3737   Python Shell Tool <perspectives/calculator/python_shell_help> 
    3838    
    39    Test Data <../test/testdata_help.rst> 
     39   Test Data <test/testdata.rst> 
  • sasview/README.txt

    rd47b9ce r42dbcfb  
    22============= 
    33 
    4 1- Features 
    5 =========== 
    6  
    7    - New in Version 3.1.0 
    8      -------------------- 
    9      - The documentation/help has had a complete overhaul including: 
    10        - A completely new presentation interface (Sphinx). 
    11        - Proof reading! 
    12        - Updating for latest features. 
    13        - A Help (or sometimes ?) button has been added to every panel, and some 
    14          sub panels if appropriate, linking to the appropriate section in the 
    15          documentation. 
    16        - The model help has been split so that the Details button now brings up 
    17          a very short pop-up giving the equation being used while HELP goes to  
    18          the section in the full documentation describing the model. 
    19        - Extensive help has also been added for the new optimizer engine (see  
    20          below) including rules of thumb on how and when to choose a given 
    21          optimizer and what the parameters do. 
    22      - The optimizer engine has been completely replaced. The new optimizer 
    23        still defaults to the standard Levenberg-Marquardt algorithm. However 4 
    24        other optimizers are now also available. Each starts with a set of default 
    25        parameters which can be tuned. The DREAM optimizer takes the longest but 
    26        is the most powerful and yields rich information including full parameter 
    27        correlation and uncertainty plots. A results panel has been added to 
    28        accommodate this. 
    29        - The five new optimizers are: 
    30          - A Levenberg-Marquardt optimizer 
    31          - A Quasi-Newton BFGS optimizer 
    32          - A Nelder-Mead Simplex optimizer 
    33          - A Differential Evolution optimizer 
    34          - A Monte Carlo optimizer (DREAM)  
    35      - New models were added: 
    36          - MicelleSphCoreModel (currently residing in the Uncategorized category) 
    37      - Existing models were updated: 
    38          - RectangularPrismModel 
    39          - RectangularHollowPrismModel 
    40          - RectangularHollowPrismInfThinWallsModel 
    41      - Infrastructure to allow SESANS data to be fit with models was added. This 
    42        will become available in a future release but can currently be used from  
    43        the command line with some caveats. 
    44      - A number of bugs were fixed including a thread crashing issue and an 
    45        incorrect slit smearing resolution calculation. 
    46      - Implemented much more robust error logging to enable much easier 
    47        debugging in general but particularly the debugging of issues reported by 
    48        SasView users. 
    49      - A number of infrastructure tasks under the hood to enhance maintainability 
    50      - Upgrade from Wx 2.8 to Wx 3.0.2 which allows several new features but 
    51        required significant additional rework as well. 
    52      - Fully implemented Sphinx to the build process to produce both better 
    53        user documentation and developer documentation. 
    54      - Restructuring of the code base to more unified nomenclature and structure 
    55        so that the source installation tree more closely matches the installer 
    56        version tree. 
    57      - Code cleanup (an ongoing task) . 
    58      - Migration of the repository to github simplifying contributions from 
    59        non-project personnel through pull requests. 
    60  
    61    - New in Version 3.0.0 
    62      -------------------- 
    63      - The GUI look and feel has been refactored to be more familiar for 
    64        Windows users by using MDI frames. Graph windows are also now free- 
    65        floating. 
    66      - Five new models have been added: PringlesModel, CoreShellEllipsoidXTModel, 
    67        RectangularPrismModel, RectangularHollowPrismModel and  
    68        RectangularHollowPrismInfThinWallsModel. 
    69      - The data loader now supports ILL DAT data files and reads the full meta  
    70        information from canSAS file formats. 
    71      - Redefined convention for specifying angular parameters for anisotropic 
    72        models. 
    73      - A number of minor features have been added such as permitting a log  
    74        distribution of points when using a model to simulate data, and the  
    75        addition of a Kratky plot option to the linear plots. 
    76      - A number of bugs have also been fixed. 
    77      - Save Project and Save Analysis now work more reliably. 
    78      - BETA: Magnetic contrast supporting full polarization analysis has been  
    79        implemented for some spherical and cylindrical models. 
    80      - BETA: Two new tools have been added: 
    81        - A generic scattering calculator which takes an atomic, magnetic or  
    82          SLD distribution in space and generates the appropriate 2D  
    83          scattering pattern. In some cases the orientationally averaged  
    84          (powder) 1D scattering can also be computed. Supported formats  
    85          include: SLD or text, PDB, and OMF magnetic moment distribution  
    86          file. 
    87        - An image viewer/converter for data in image format; this reads in  
    88          an image file and will attempt to convert the image pixels to  
    89          data. Supported formats include: TIFF, TIF, PNG, BMP, JPG. 
    90  
    91    - New in Version 2.2.1 
    92      -------------------- 
    93      - Minor patch to support CanSAS XML v1.1 file format 
    94      - Added DataInfo for data in the DataExplorer and plots 
    95      - Added Maximize/Restore button in the title bar of the graphs 
    96      - Added a hide button in the toolbar of the graph panel 
    97      - The 'x' button now deletes a graph 
    98      - Edit SUM Model from the menubar can now generate and save more than one sum model 
    99      - Reports can now be saved in pdf format on WIN and MAC 
    100      - Made significant improvements to the batch/grid panel and fixed several bugs 
    101      - Fixed a number of other minor bugs 
    102  
    103    - New in Version 2.2.0 
    104      -------------------- 
    105      - Application name changed to SasView 
    106      - New fully customizable Category Manager added for better management of 
    107        increasing number of models 
    108      - Improved the Grid Window functionality in the batch fitting mode 
    109      - Added a simpler Graph/Plot modification interface 
    110      - Added a new 'Data Operation' tool for addition, subtraction, multiplication, 
    111        division, of two data sets. 
    112      - The 'Sum Model' editor was extended and renamed 'Summation and Multiplication' 
    113        editor 
    114      - Added more plot symbols options for 1d plots 
    115      - Added improved trapping of compiling errors to the 'New model editor' 
    116      - Added some intelligent outputs (e.g., Rg, background, or rod diameter  
    117        depending on the choice of axis scale of the plot) to the linear fits 
    118      - Added more models 
    119       
    120    - Feature set from previous versions          
    121      ----------------------------------- 
    122      - Perspectives Available 
    123        - Invariant calculator: Calculates the invariant, volume fraction, and 
    124          specific surface area. 
    125        - P(r) inversion calculator: Indirect Fourier transformation method. 
    126        - Fitting: the tool used for modeling and fitting 1D and 2D data to  
    127          analytical model functions 
    128        - Tools: provides a number of useful supplementary tools such as SLD 
    129          calculation   
     4SasView 3.1.0 
     5    -The documentation/help has had a complete overhaul including 
     6      - A completely new interface. 
     7      - The text has had a clean-up and been brought up to date with the latest 
     8        features. 
     9      - A Help (or sometimes ?) button has been added to every panel, and some 
     10        sub panels if appropriate, linking to the appropriate section in the 
     11        documentation. 
     12      - The model help has been split so that the details button now brings up 
     13        a very short pop-up giving the equation being used while HELP goes to  
     14        the section in the full documentation describing the model. 
     15      - Extensive help has also been added for the new optimizer engine (see  
     16        below) including rules of thumb on how and when to choose a given 
     17        optimizer and what the parameter do. 
     18    - The optimizer package has been completely replaced.  The new optimizer 
     19      still defaults to the standard Levenberg-Marquardt algorithm.  However 4 
     20      other optimizers are now available. Each starts with a set of default 
     21      parameters which can be tuned.  The DREAM optimizer takes the longest but 
     22      is the most powerful and yields rich information including full parameter 
     23      correlation and uncertainty plots.  A results panel has been added to 
     24      accommodate this.  The five optimizers are: 
     25      - A Levenberg-Marquardt optimizer 
     26      - A Quasi-Newton BFGS optimizer 
     27      - A Nelder-Mead Simplex optimizer 
     28      - A Differential Evolution optimizer 
     29      - A Monte Carlo optimizer DREAM optimizer  
     30    - Several new models added (what are they) 
     31    - Infrastructure to allow SESANS data to bit fit with models in a future 
     32      release was added and can currently be used from command line with some 
     33      caveats. 
     34    - A number of bugs were fixed including a thread crashing issue and a 
     35      incorrect resolution slit smearing. 
     36    - Implemented much more robust error logging to better enable much easier 
     37      debugging in general and particularly debugging an issue reported by 
     38      SasView user. 
     39    - A number of infrastructure tasks under the hood to enhance maintainability 
     40      - Upgrade from Wx 2.9 to 3.0.2 which allows several new features but 
     41        required significant other rework as well. 
     42      - Fully implemented Sphinx to the build process to produce both better 
     43        user documentation and developer documentation. 
     44      - Restructuring of code base to more unified nomenclature and structure 
     45        so that source installation tree more closely matches the installer 
     46        version tree. 
     47      - Code cleanup (an ongoing task)  
     48      - Migration of repository to github simplifying contributions from 
     49        non-project personnel through pull requests 
     50 
     51 
     52    - New in Version 3.0.0 
     53      - The GUI look and feel has been refactored to be more familiar for 
     54        Windows users by using MDI frames. Graph windows are also now free- 
     55        floating. 
     56      - Five new models have been added: PringlesModel, CoreShellEllipsoidXTModel, 
     57        RectangularPrismModel, RectangularHollowPrismModel and  
     58        RectangularHollowPrismInfThinWallsModel. 
     59      - The data loader now supports ILL DAT data files and reads the full meta  
     60        information from canSAS file formats. 
     61      - Redefined convention for specifying angular parameters for anisotropic 
     62        models. 
     63      - A number of minor features have been added such as permitting a log  
     64        distribution of points when using a model to simulate data, and the  
     65        addition of a Kratky plot option to the linear plots. 
     66      - A number of bugs have also been fixed. 
     67      - Save Project and Save Analysis now work more reliably. 
     68      - BETA: Magnetic contrast supporting full polarization analysis has been  
     69            implemented for some spherical and cylindrical models. 
     70      - BETA: Two new tools have been added: 
     71            * A generic scattering calculator which takes an atomic, magnetic or  
     72              SLD distribution in space and generates the appropriate 2D  
     73              scattering pattern. In some cases the orientationally averaged  
     74              (powder) 1D scattering can also be computed. Supported formats  
     75              include: SLD or text, PDB, and OMF magnetic moment distribution  
     76              file. 
     77            * An image viewer/converter for data in image format; this reads in  
     78              an image file and will attempt to convert the image pixels to  
     79              data. Supported formats include: TIFF, TIF, PNG, BMP, JPG. 
     80 
     81    - New in Version 2.2.1 
     82      - Minor patch to support CanSAS XML v1.1 file format 
     83      - Added DataInfo for data in the DataExplorer and plots 
     84      - Added Maximize/Restore button in the title bar of the graphs 
     85      - Added a hide button in the toolbar of the graph panel 
     86      - The 'x' button now deletes a graph 
     87      - Edit SUM Model from the menubar can now generate and save more than one sum model 
     88      - Reports can now be saved in pdf format on WIN and MAC 
     89      - Made significant improvements to the batch/grid panel and fixed several bugs 
     90      - Fixed a number of other minor bugs 
     91 
     92    - New in Version 2.2.0 
     93      - Application name changed to SasView 
     94      - New fully customizable Category Manager added for better management of 
     95        increasing number of models 
     96      - Improved the Grid Window functionality in the batch fitting mode 
     97      - Added a simpler Graph/Plot modification interface 
     98      - Added a new 'Data Operation' tool for addition, subtraction, multiplication, 
     99        division, of two data sets. 
     100      - The 'Sum Model' editor was extended and renamed 'Summation and Multiplication' 
     101        editor 
     102      - Added more plot symbols options for 1d plots 
     103      - Added improved trapping of compiling errors to the 'New model editor' 
     104      - Added some intelligent outputs (e.g., Rg, background, or rod diameter depending on the choice of axis scale of the plot) to the linear fits 
     105      - Added more models 
     106 
     107    - Feature set from Previous Versions:        
    130108     
    131      - Fitting  
    132        - Includes a large number of model functions, both form factors and structure factors. 
    133        - Support P(Q)*S(Q) for form factors that flag they can be so multiplied. 
    134        - Supports Gaussian, lognormal, Shulz, rectangular and custom distribution 
    135          functions for models that need to include polydispersity or for orientational 
    136          distributions if appropriate. 
    137        - Anisotropic shapes and magnetic moment modeling in 2D allow for a non-uniform 
    138          distribution of orientations of a given axis leading to modeling and fitting 
    139          capabilities of non azimuthaly symmetric data.   
    140        - User can choose to weight fits or not. If using weights, the user can choose 
    141          the error bar on each point if provided in the file, the square root 
    142          of the intensity or the intensity itself.  
    143        - Instrumental resolution smearing of model or fits is provided with several 
    144          options: read the resolution/point fromt he file. Input a pinhole resolution 
    145          or a slit resolution. 
    146        - Users can define the Qrange (Qmin and Qmax) for both 1D and 2D data for 
    147          fitting and modeling, but not graphically.  The range can be reset to the 
    148          defaults (limits of q in data set for a fit) with the reset button. 
    149        - A mask can be applied to 2D calculation and fitting. 
    150        - Normalized residual plots are provided with every fit. 
    151        - Model function help available through detail button or from the fitting panel. 
    152        - Simultaneous/(advanced)constrained fitting allows for fitting a single 
    153          data set or several different sets simultaneously with the application 
    154          of advanced constraints relating fit parameters to functions of other 
    155          parameters (including from a different set). For example thickness of  
    156          shell = sin(30) times the length.   
    157        - Models that are the sum of two other models can be easily generated through the 
    158          SUM Model menubar item. 
    159        - New Python models can be added on the fly by creating an appropriate Python 
    160          file in the model plugin directory. Two tools are provided to help: 
    161          An easy to use custom model editor allows the quick generation of new Python 
    162          models by supplying only the parameters and their default value (box 1) 
    163          and the mathematical function of the model (box 2) and generating the 
    164          necessary *.py file.  A separate advanced model editor provides a full Python 
    165          file editor.  Either way once saved the model becomes immediately available  
    166          to the application.  
    167        - A batch fitting capability allows for the analysis of a series of data sets to 
    168          a single model and provides the results in a tabular form suitable for saving 
    169          or plotting the evolution of the fit parameters with error bars (from within 
    170          the application). 
     109    - Perspectives Available 
     110      - Invariant calculator: Calculates the invariant, volume fraction, and 
     111        specific surface area. 
     112      - P(r) inversion calculator: Indirect Fourier transformation method. 
     113      - Fitting: the tool used for modeling and fitting 1D and 2D data to  
     114        analytical model functions 
     115      - Tools: provides a number of useful supplementary tools such as SLD 
     116        calculation   
     117     
     118    - Fitting  
     119      - Includes a large number of model functions, both form factors and structure factors. 
     120      - Support P(Q)*S(Q) for form factors that flag they can be so multiplied. 
     121      - Supports Gaussian, lognormal, Shulz, rectangular and custom distribution 
     122        functions for models that need to include polydispersity or for orientational 
     123        distributions if appropriate. 
     124      - Anisotropic shapes and magnetic moment modeling in 2D allow for a non-uniform 
     125        distribution of orientations of a given axis leading to modeling and fitting 
     126        capabilities of non azimuthaly symmetric data.   
     127      - User can choose to weight fits or not. If using weights, the user can choose 
     128        the error bar on each point if provided in the file, the square root 
     129        of the intensity or the intensity itself.  
     130      - Instrumental resolution smearing of model or fits is provided with several 
     131        options: read the resolution/point fromt he file. Input a pinhole resolution 
     132        or a slit resolution. 
     133      - Users can define the Qrange (Qmin and Qmax) for both 1D and 2D data for 
     134        fitting and modeling, but not graphically.  The range can be reset to the 
     135        defaults (limits of q in data set for a fit) with the reset button. 
     136      - A mask can be applied to 2D calculation and fitting. 
     137      - Normalized residual plots are provided with every fit. 
     138      - Model function help available through detail button or from the fitting panel. 
     139      - Simultaneous/(advanced)constrained fitting allows for fitting a single 
     140        data set or several different sets simultaneously with the application 
     141        of advanced constraints relating fit parameters to functions of other 
     142        parameters (including from a different set). For example thickness of  
     143        shell = sin(30) times the length.   
     144      - Models that are the sum of two other models can be easily generated through the 
     145        SUM Model menubar item. 
     146      - New Python models can be added on the fly by creating an appropriate Python 
     147        file in the model plugin directory. Two tools are provided to help: 
     148        An easy to use custom model editor allows the quick generation of new Python 
     149        models by supplying only the parameters and their default value (box 1) 
     150        and the mathematical function of the model (box 2) and generating the 
     151        necessary *.py file.  A separate advanced model editor provides a full Python 
     152        file editor.  Either way once saved the model becomes immediately available  
     153        to the application.  
     154      - A batch fittng capability allows for the analysis of a series of data sets to 
     155        a sinble model and provides the results in a tabular form suitable for saving 
     156        or plotting the evolution of the fit parameters with error bars (from within 
     157        the application). 
    171158  
    172      - Tools 
    173        - A scattering length density calculator,including some X-ray information 
    174          is provided. 
    175        - A density to vol. fraction converter is provided 
    176        - In application access to a Python shell/editor (PyCrust) is provided 
    177        - An instrument resolution calculator, including possible gravitational and 
    178          TOF effects is provided 
    179        - A slit size calculator optimized for Anton Paar Saxess is provided. 
    180        - A kiessig fringe thickness calculator is provided 
    181           
    182      - Plots and plot management 
    183        - A 3D graphing option (for 2d data/results) is provided with the view 
    184          controlled by the mouse 
    185        - 2D plots are shown with an intensity color bar. 2D Color map can be user 
    186          adjusted. 
    187        - Supports output of plot to a variety of graphic formats. Supported formats 
    188          include: png, eps, emf, jpg/jpeg, pdf, ps, tif/tiff, rawRGBbitmap(raw, rgba), 
    189          and scalable vector graphic (svg/svgz) 
    190        - Supports ouput of data in plot (1 or 2D) to limited data formats 
    191        - Multiple data sets can be loaded into a single graph for viewing (but a fit 
    192          plot can currently only have a single plot). 
    193        - Extensive context sensitive plot/fitting/manipulation options are available 
    194          through a right mouse click pop-up menu on plots. 
    195             
    196      - Data management 
    197        - Supports 2 + column 1D ASCII data, NIST 1D and 2D data, and canSAS data 
    198          via plug-in mechanism which can easily allow other readers as appropriate.  
    199        - 2D data is expected in Q space but for historical reasons accepts the 
    200          NIST 2D raw pixel format and will do conversion internally. 
    201        - The full data and metadata available to SasView is viewable in ASCII via 
    202          right clicking on a data set and choosing Data Info in the DataExplorer 
    203          or on the plots 
    204        - Supports loading a single file, multiple files, or a whole folder    
    205        - An optional Data Explorer is provided (default) which simplifies managing, 
    206          plotting, deleting, or setup for computation. Most functions however do 
    207          not require access to the explorer/manager and can be accessed through 
    208          right click menus and the toolbar.  The data explorer can be re-started 
    209          from the menu bar. 
    210             
    211      - Data manipulation 
    212        - Support various 2D averaging methods : Circular, sectors, annular, 
    213          boxsum, boxQx and boxQy. 
    214        - A 2D data maks editor is provided 
    215        - 2D mask can be applied to the circular averaging. 
    216           
    217      - Miscellaneous features 
    218        - limited reports can be generated in pdf format 
    219        - Provides multiprocessor support(Windows only) 
    220        - Limited startup customization currently includes default startup 
    221          data folder and choice of default starting with data manager 
    222        - Limited support for saving(opening) a SasView project or a SasView analysis 
    223          (subproject) is provided. 
    224        - SasView can be launched and loaded with a file of interesty by double-clicking 
    225          on that file (recognized extension) 
    226        - A data file or data folder can be passed to SasView when launched from 
    227          the command line. 
    228        - Limited bookmarking capability to later recall the results of a fit calculation 
    229          is provided. 
    230        - Extensive help is provided through context sensitive mouse roll-over, 
    231          information bar (at the bottom of the panel), the console menu, and 
    232          access to the help files in several different ways. 
     159    - Tools 
     160      - A scattering length density calculator,including some X-ray information 
     161        is provided. 
     162      - A density to vol. fraction converter is provided 
     163      - In application access to a Python shell/editor (PyCrust) is provided 
     164      - An instrument resolution calculator, including possible gravitational and 
     165        TOF effects is provided 
     166      - A slit size calculator optimized for Anton Paar Saxess is provided. 
     167      - A kiessig fringe thickness calculator is provided 
     168    - Plots and plot management 
     169      - A 3D graphing option (for 2d data/results) is provided with the view 
     170        controlled by the mouse 
     171      - 2D plots are shown with an intensity color bar. 2D Color map can be user 
     172        adjusted. 
     173      - Supports output of plot to a variety of graphic formats. Supported formats 
     174        include: png, eps, emf, jpg/jpeg, pdf, ps, tif/tiff, rawRGBbitmap(raw, rgba), 
     175        and scalable vector graphic (svg/svgz) 
     176      - Supports ouput of data in plot (1 or 2D) to limited data formats 
     177      - Multiple data sets can be loaded into a single graph for viewing (but a fit 
     178        plot can currently only have a single plot). 
     179      - Extensive context sensitive plot/fitting/manipulation options are available 
     180        through a right mouse click pop-up menu on plots.   
     181    - Data management 
     182      - Supports 2 + column 1D ASCII data, NIST 1D and 2D data, and canSAS data 
     183        via plug-in mechanism which can easily allow other readers as appropriate.  
     184      - 2D data is expected in Q space but for historical reasons accepts the 
     185        NIST 2D raw pixel format and will do conversion internally. 
     186      - The full data and metadata available to SasView is viewable in ASCII via 
     187        right clicking on a data set and choosing Data Info in the DataExplorer 
     188        or on the plots 
     189      - Supports loading a single file, multiple files, or a whole folder    
     190      - An optional Data Explorer is provided (default) which simplifies managing, 
     191        plotting, deleting, or setup for computation. Most functions however do 
     192        not require access to the explorer/manager and can be accessed through 
     193        right click menus and the toolbar.  The data explorer can be re-started 
     194        from the menu bar. 
     195    - Data manipulation 
     196      - Support various 2D averaging methods : Circular, sectors, annular, 
     197        boxsum, boxQx and boxQy. 
     198      - A 2D data maks editor is provided 
     199      - 2D mask can be applied to the circular averaging. 
     200    - Miscellaneous features 
     201      - limited reports can be generated in pdf format 
     202      - Provides multiprocessor support(Windows only) 
     203      - Limited startup customization currently includes default startup 
     204        data folder and choice of default starting with data manager 
     205      - Limited support for saving(opening) a SasView project or a SasView analysis 
     206        (subproject) is provided. 
     207      - SasView can be launched and loaded with a file of interesty by double-clicking 
     208        on that file (recognized extension) 
     209      - A data file or data folder can be passed to SasView when launched from 
     210        the command line. 
     211      - Limited bookmarking capability to later recall the results of a fit calculation 
     212        is provided. 
     213      - Extensive help is provided through context sensitive mouse roll-over, 
     214        information bar (at the bottom of the panel), the console menu, and 
     215        access to the help files in several different ways. 
     216 
    233217 
    234218 
    2352192- Downloading and Installing 
    236 ============================= 
    237220         
    238    *** Note 1:  Much more information is available at www.sasview.org under links. 
    239                     Look in the 'For Developers' section and particularly the wiki at 
    240                 www.sasview.org/trac/wiki. 
    241    *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of 
    242                 the following.  However it is highly recommended that any 
    243                 previous versions be un-installed prior to installing the 
    244                 new version. 
    245  
    246    2.1- System Requirements 
     221    *** Note 1:  Much more information is available at www.sasview.org under links. 
     222                     Look in the 'For Developers' section and particularly the wiki at 
     223                     www.sasview.org/trac/wiki. 
     224    *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of 
     225                 the following.  However it is highly recommended that any 
     226                 previous versions be un-installed prior to installing the 
     227                 new version. 
     228 
     229    2.1- System Requirements: 
    247230        - Python version >= 2.5 and < 3.0 should be running on the system 
    248231        - We currently use Python 2.7 
    249232 
    250    2.2- Installing from source 
     233    2.2- Installing from source: 
    251234        - Get the code from GitHub at https://github.com/SasView/sasview.git 
    252235          for this release version use: https://github.com/SasView/sasview/releases 
    253           - run 'python setup.py install' under the 'sasview-x.x.x' folder 
    254           - run 'python sasview.py' under the 'sasview' folder. 
    255            
     236            - run 'python setup.py install' under the 'sasview-x.x.x' folder 
     237            - run 'python sasview.py' under the 'sasview' folder. 
    256238        - The following modules are required (version numbers are what are used 
    257239          in the windows release build): 
     240        - Common Packages 
     241          - reportlab 3.1.44 
     242          - lxml 3.4.4.0 (MAC 3.4.2.0) 
     243          - PIL 1.1.7 
     244          - xhtml2pdf 3.0.33 (MAC = not installed on build server) 
     245          - unittest-xml-reporting 1.12.0 (MAC 1.10.0) 
     246          - matplotlib Version Installed: 1.4.3 (MAC 1.1.1) 
     247          - bumps Version Installed: 0.7.5.6 
     248          - scipy Version Installed: 0.16.0b2 (MAC 0.11.0) 
     249          - periodictable Version Installed: 1.4.1 
     250          - setuptools Version Installed: 7.0 (MAC 12.0.5) 
     251          - sphinx Version Installed: 1.3.1 (MAC 1.3b2) 
     252          - pyparsing Version Installed: 2.0.3 
     253          - numpy Version Installed: 1.9.2 (MAC 1.6.2) 
     254          - html5lib Version Installed: 0.99999 
     255          - wx Version Installed: 3.0.2.0 
    258256           
    259           - Common Packages 
    260             - reportlab 3.1.44 
    261             - lxml 3.4.4.0 (MAC 3.4.2.0) 
    262             - PIL 1.1.7 
    263             - xhtml2pdf 3.0.33 (MAC = not installed on build server) 
    264             - unittest-xml-reporting 1.12.0 (MAC 1.10.0) 
    265             - matplotlib Version Installed: 1.4.3 (MAC 1.1.1) 
    266             - bumps Version Installed: 0.7.5.6 
    267             - scipy Version Installed: 0.16.0b2 (MAC 0.11.0) 
    268             - periodictable Version Installed: 1.4.1 
    269             - setuptools Version Installed: 7.0 (MAC 12.0.5) 
    270             - sphinx Version Installed: 1.3.1 (MAC 1.3b2) 
    271             - pyparsing Version Installed: 2.0.3 
    272             - numpy Version Installed: 1.9.2 (MAC 1.6.2) 
    273             - html5lib Version Installed: 0.99999 
    274             - wx Version Installed: 3.0.2.0 
    275            
    276           - Windows Specific Packages 
    277             - pywin 219 
    278             - py2exe 0.6.9 
    279             - comtypes 1.1.1 
    280             - MinGW w/ gcc version 4.6.1 (WIN) 
    281             - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008  
     257 
     258        - Windows Specific Packages: 
     259          - pywin 219 
     260          - py2exe 0.6.9 
     261          - comtypes 1.1.1 
     262          - MinGW w/ gcc version 4.6.1 (WIN) 
     263          - vcredist_x86.exe (version 9.0.21022.8  -microsoft visual C 2008  
    282264              re-distributable) 
    283             - Innosetup (WIN - isetup 5.4.2-unicode) - used to create distributable 
    284  
    285             *** Note: Windows build dependencies can be set up using anaconda. Instructions 
    286                 can be found at http://trac.sasview.org/wiki/AnacondaSetup 
     265          - Innosetup (WIN - isetup 5.4.2-unicode) - used to create distributable 
    287266             
    288           - MAC Specifc Packages 
    289             - py2app 0.7.1 
    290            
     267        - MAC Specifci Packages: 
     268          - py2app 0.7.1 
     269        - Windows build dependencies can be set up using anaconda. Instructions 
     270          can be found at http://trac.sasview.org/wiki/AnacondaSetup 
     271 
    291272 
    2922733- Known Issues 
    293 =============== 
    294  
    295    3.1- All systems: 
    296         - The documentation window may take a few seconds to load the first time 
    297           it is called. Also, an internet connection is required before 
     274 
     275    3.1- All systems: 
     276        - Documentation Window may take a few seconds to load the first time 
     277          it i called.  Also, an internet connection is required before 
    298278          equations will render properly. Until then they will show in their 
    299279          original TeX format. 
    300         - If the documentation window remains stubbornly blank, try installing a  
    301           different browser and set that as your default browser. Issues have 
    302           been noted with Internet Explorer 11. 
    303280        - The copy and paste functions (^C, ^V) in the batch mode results grid 
    304281          require two clicks: one to select the cell and a second to select the 
    305282          contents of the cell.  
    306         - The tutorial has not yet been updated and is somewhat out of date 
    307         - Very old computers may struggle to run the 3.x and later releases 
     283        - Tutorial has not yet been updated and is somewhat out of date 
     284        - Very old computers may not be able to run 
    308285        - Polydispersity on multiple parameters included in a simultaneous/ 
    309286          constrained fit will likely not be correct 
     
    319296          some cases lead to incorrect calculations(ticket #332) 
    320297           
    321    3.2- Windows: 
     298 
     299    3.2- Windows: 
    322300        - If installed to same directory as old version without first removing 
    323301          the old version, the old desktop icon will remain but point to the 
     
    326304          safest to uninstall old version prior to installing new version anyway. 
    327305                 
    328    3.3- MAC: 
     306    3.3- MAC: 
    329307        - Application normally starts up hidden. Click icon in Dock to view/use 
    330308          application.  
    331         - Multiprocessing does not currently work on MAC OS 
     309        - multiprocessing does not currently work on MAC OS 
    332310                 
    333    3.4- Linux: 
     311    3.4- Linux: 
    334312        - Not well tested 
    335313 
    336  
    3373144- SasView website 
    338 ================== 
    339  
    340    - www.sasview.org.  This main project site is the gateway to all  
    341      information about the sasview project.  It includes information 
    342      about the project, a FAQ page and links to all developer and user 
    343      information, tools and resources. 
    344  
     315 
     316    - www.sasview.org.  This main project site is the gateway to all  
     317      information about the sasview project.  It includes information 
     318      about the project, a FAQ page and links to all developer and user 
     319      information, tools and resources. 
    345320 
    3463215- Frequently Asked Questions 
    347 ============================= 
    348  
    349    - www.sasview.org/faq.html 
    350  
     322 
     323    - www.sasview.org/faq.html 
    351324 
    3523256- Installer download website 
    353 ============================= 
    354  
    355    - Latest release Version 
    356      - https://github.com/SasView/sasview/releases 
    357    - Latest developer builds 
    358      - https://jenkins.esss.dk/sasview/view/Master-Builds/ 
     326 
     327    - Latest release Version 
     328        - https://github.com/SasView/sasview/releases 
     329    - Latest developer builds 
     330        - https://jenkins.esss.dk/sasview/view/Master-Builds/ 
    359331 
    360332     
  • sasview/test/media/testdata_help.rst

    r0d10aab re5160aa  
    2525.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    2626 
    27 1D Test Data 
    28 ^^^^^^^^^^^^ 
    29  
    30 AOT_Microemulsion 
    31   - Aerosol-OT surfactant stabilised oil-in-water microemulsion data at three  
    32     contrasts: core (oil core), drop (oil core + surfactant layer), and shell  
    33     (surfactant layer). 
    34   - Suitable for testing simultaneous fitting. 
    35    
    36 hSDS_D2O 
    37   - h25-sodium dodecyl sulphate solutions at two concentrations: 0.5wt% (just  
    38     above the cmc), 2wt% (well above the cmc), and 2wt% but with 0.2mM NaCl  
    39     electrolyte. 
    40   - Suitable for testing charged S(Q) models. 
    41  
    42 P123_D2O 
    43   - Lyotropic liquid crystalline solutions of non-ionic ABA block copolymer  
    44     Pluronic P123 in water at three concentrations: 10wt%, 30wt%, and 40wt%. 
    45   - Suitable for testing paracrystal models. 
    46  
    47 ISIS_Polymer_Blend_TK49 
    48   - Monodisperse (Mw/Mn~1.02) 49wt% d8-polystyrene : 51wt% h8-polystyrene  
    49     polymer blend. 
    50   - Suitable for testing Poly_GaussCoil and RPA10 models. 
    51  
    52 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    53  
    54 2D Test Data 
    55 ^^^^^^^^^^^^ 
    56  
    57 P123_D2O 
    58   - Lyotropic liquid crystalline solutions of non-ionic ABA block copolymer  
    59     Pluronic P123 in water at three concentrations: 10wt%, 30wt%, and 40wt%. 
    60   - Suitable for testing paracrystal models. 
    61  
    62 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    63  
    64 Saved State Test Data 
    65 ^^^^^^^^^^^^^^^^^^^^^ 
    66  
    67 _phi_weights.txt 
    68  
    69 _radius_dist.txt 
    70  
    71 _THETA_weights.txt 
    72  
    73 fitstate.fitv 
    74  
    75 newone.svs 
    76  
    77 prstate.prv 
    78  
    79 sld_file.sld 
    80  
    81 test.inv 
    82  
    83 test002.inv 
    84  
    85 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    86  
    87 Other Test Data 
    88 ^^^^^^^^^^^^^^^ 
    89  
    90 1000A_sphere_sm.xml 
    91  
    92 diamond.pdb 
    93  
    94 dna.pdb 
    95  
    96 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    97  
    98 .. note::  This help document was last changed by Steve King, 26Jun2015 
     27.. note::  This help document was last changed by Steve King, 17Jun2015 
  • src/sas/guiframe/gui_manager.py

    r22d92da r22d92da  
    13031303            if menu_list: 
    13041304                for (menu, name) in menu_list: 
     1305                    print "[%s]" % name 
    13051306                    self._menubar.Replace(pos, menu, name) 
    13061307                    self._applications_menu_name = name 
  • src/sas/models/media/model_functions.rst

    ree9fa94 r5e880fe1  
    2020 
    2121 
    22 .. note::  The contents of this document are presented in good faith and are  
    23            believed to be mostly correct and accurate, however they have not  
    24            yet been rigorously checked for errors. June2015 
     22.. note::  The contents of this document are awaiting proof reading. Feb2015 
    2523 
    2624 
     
    8583======================= 
    8684 
     85Contents 
     86-------- 
     871. Background_ 
     88 
     892. Model_ Functions 
     90 
     91 2.1 Shape-based_ Functions 
     92  
     93 2.2 Shape-independent_ Functions 
     94  
     95 2.3 Structure-factor_ Functions 
     96  
     97 2.4 Customised_ Functions 
     98 
     993. References_ 
     100 
     101 
     102 
     103.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     104 
     105 
     106 
    87107.. _Background: 
    88108 
     
    270290- sph_bessel_jn_ 
    271291 
    272 Also see the documentation on :ref:`Adding_your_own_models` under Fitting Data.  
    273  
    274292 
    275293 
  • src/sas/perspectives/fitting/pagestate.py

    ra15e754 racf8e4a5  
    545545                    paramval_string += CENTRE % param + "\n" 
    546546 
    547         text_string = "\n\n\n%s\n\n%s\n%s\n%s\n\n%s" % (title, file, q_name, chi2, paramval) 
     547        text_string = "\n\n\n" + title + "\n\n" + file + \ 
     548                      "\n" + q_name + \ 
     549                      "\n" + chi2 + \ 
     550                      "\n\n" + paramval 
    548551 
    549552        title_name = self._check_html_format(title_name) 
  • src/sas/perspectives/fitting/report_dialog.py

    ra15e754 r2f4b430  
    4444                self.report_html = self.report_list[0] % \ 
    4545                                    "memory:img_fit0.png" 
    46             elif len(self.report_list[2]) == 2: 
     46            elif len(self.report_list) == 2: 
    4747                self.report_html = self.report_list[0] % \ 
    4848                                    ("memory:img_fit0.png", 
Note: See TracChangeset for help on using the changeset viewer.