Changes in / [e6de6b8:95eef00] in sasview


Ignore:
Files:
33 deleted
6 edited

Legend:

Unmodified
Added
Removed

  • docs/sphinx-docs/build_sphinx.py

    rdd72190 r751f4bd  
    218218                    shutil.copy(fromhere,tohere) 
    219219 
    220  
    221220    if os.path.exists(SASMODELS_SOURCE_SESANS): 
    222221        print "Found docs folder SASMODELS_SOURCE_SESANS at ", SASMODELS_SOURCE_SESANS 
    … …  
    244243        print "Found img folder SASMODELS_SOURCE_MAGIMG   at ", SASMODELS_SOURCE_MAGIMG 
    245244        if not os.path.exists(SASMODELS_DEST_MAGIMG): 
    246             print "Missing docs folder SASMODELS_DEST_MAGIMG at ", SASMODELS_DEST_MAGIMG 
     245            print "Missing img folder SASMODELS_DEST_MAGIMG at ", SASMODELS_DEST_MAGIMG 
    247246            os.makedirs(SASMODELS_DEST_MAGIMG) 
    248247            print "created SASMODELS_DEST_MAGIMG at ", SASMODELS_DEST_MAGIMG 
    249         print "Copying sasmodels model auto-generated image files..." 
     248        print "Copying sasmodels mag image files..." 
    250249        for files in os.listdir(SASMODELS_SOURCE_MAGIMG): 
    251250            fromhere=os.path.join(SASMODELS_SOURCE_MAGIMG,files) 
    … …  
    255254 
    256255    if os.path.exists(SASMODELS_SOURCE_SESANSIMG): 
    257         print "Found img folder SASMODELS_SOURCE_MAGIMG   at ", SASMODELS_SOURCE_SESANSIMG 
    258         if not os.path.exists(SASMODELS_DEST_MAGIMG): 
    259             print "Missing docs folder SASMODELS_DEST_MAGIMG at ", SASMODELS_DEST_SESANSIMG 
     256        print "Found img folder SASMODELS_SOURCE_SESANSIMG   at ", SASMODELS_SOURCE_SESANSIMG 
     257        if not os.path.exists(SASMODELS_DEST_SESANSIMG): 
     258            print "Missing img folder SASMODELS_DEST_SESANSIMG at ", SASMODELS_DEST_SESANSIMG 
    260259            os.makedirs(SASMODELS_DEST_SESANSIMG) 
    261260            print "created SASMODELS_DEST_SESANSIMG at ", SASMODELS_DEST_SESANSIMG 
    262         print "Copying sasmodels model auto-generated image files..." 
     261        print "Copying sasmodels sesans image files..." 
    263262        for files in os.listdir(SASMODELS_SOURCE_SESANSIMG): 
    264263            fromhere=os.path.join(SASMODELS_SOURCE_SESANSIMG,files) 

  • docs/sphinx-docs/source/user/README-ABOUT-TOCTREE-FILES.TXT

    r54a2c927 re697487  
    11 
    2 The .rst files here in /sasview/docs/sphinx-docs/source/user are Sphinx toctree files. 
     2Several of the .rst files here in /sasview/docs/sphinx-docs/source/user are Sphinx toctree files. 
    33 
    44DO NOT delete them! 
    55 
     6analysis.rst 
     7tools.rst 
     8user.rst 
     9working.rst 
     10 
    611They are based on, but are different - because the SasView and Sasmodels directory trees  
    712are different - to files with the same name in /sasmodels/doc/ref/models. 

  • docs/sphinx-docs/source/user/working.rst

    r578a11d r751f4bd  
    2121   Converting SANS to SESANS <sans_to_sesans> 
    2222    
     23   Fitting SESANS Data <sesans_fitting.rst> 
     24    

  • sasview/local_config.py

    r06707b6 radb0851  
    8888_welcome_image = os.path.join(icon_path, "SVwelcome.png") 
    8989_copyright = "(c) 2009 - 2016, UTK, UMD, NIST, ORNL, ISIS, ESS, ILL and ANSTO" 
    90  
     90marketplace_url = "http://marketplace.sasview.org/" 
    9191 
    9292#edit the list of file state your plugin can read 

  • src/sas/sasgui/guiframe/gui_manager.py

    re6de6b8 re6de6b8  
    13341334                    self._applications_menu_name = name 
    13351335 
     1336    def _on_marketplace_click(self, event): 
     1337        """ 
     1338            Click event for the help menu item linking to the Marketplace. 
     1339        """ 
     1340        import webbrowser 
     1341        webbrowser.open_new(config.marketplace_url) 
     1342 
    13361343    def _add_help_menu(self): 
    13371344        """ 
    … …  
    13391346        tutorial PDF and documentation pages. 
    13401347        """ 
    1341         # Help menu 
    13421348        self._help_menu = wx.Menu() 
    1343         style = self.__gui_style & GUIFRAME.WELCOME_PANEL_ON 
    13441349 
    13451350        wx_id = wx.NewId() 
    13461351        self._help_menu.Append(wx_id, '&Documentation', '') 
    13471352        wx.EVT_MENU(self, wx_id, self._onSphinxDocs) 
    1348         self._help_menu.AppendSeparator() 
    13491353 
    13501354        if config._do_tutorial and (IS_WIN or sys.platform == 'darwin'): 
    … …  
    13521356            self._help_menu.Append(wx_id, '&Tutorial', 'Software tutorial') 
    13531357            wx.EVT_MENU(self, wx_id, self._onTutorial) 
    1354             self._help_menu.AppendSeparator() 
    1355  
    13561358 
    13571359        if config._do_acknowledge: 
    … …  
    13591361            self._help_menu.Append(wx_id, '&Acknowledge', 'Acknowledging SasView') 
    13601362            wx.EVT_MENU(self, wx_id, self._onAcknowledge) 
    1361             self._help_menu.AppendSeparator() 
    1362  
    13631363 
    13641364        if config._do_aboutbox: 
    … …  
    13671367            self._help_menu.Append(wx_id, '&About', 'Software information') 
    13681368            wx.EVT_MENU(self, wx_id, self._onAbout) 
    1369             self._help_menu.AppendSeparator() 
    1370  
     1369 
     1370        if config.marketplace_url: 
     1371            wx_id = wx.NewId() 
     1372            self._help_menu.Append(wx_id, '&Model marketplace', '') 
     1373            wx.EVT_MENU(self, wx_id, self._on_marketplace_click) 
    13711374 
    13721375        # Checking for updates 

  • src/sas/sasgui/guiframe/media/data_formats_help.rst

    r280f929 r48b8f6d  
    1010============ 
    1111 
    12 SasView reads several different 1D (I(Q) vs Q), 2D SANS(I(Qx,Qy) vs (Qx,Qy)) 
    13 and SESANS (P(z) vs z) 
    14 data files. But please note that SasView does not at present load data where 
    15 the Q and I(Q) data are in separate files. 
     12SasView reads several different 1D SAS (*I(Q) vs Q*), 2D SAS(*I(Qx,Qy) vs (Qx,Qy)*) and 1D SESANS (*P(z) vs z*) data files. From SasView 4.1 onwards, a :ref:`File_Converter_Tool` allows some legacy formats to be converted into modern formats that SasView will read. 
    1613 
    17 1D Formats SANS 
    18 --------------- 
     141D SAS Formats 
     15-------------- 
    1916 
    20 SasView will read files with 2 to 4 columns of numbers in the following order:  
     17SasView will read ASCII ('text') files with 2 to 4 columns of numbers in the following order:  
    2118 
    22     Q, I(Q), (dI(Q), dQ(Q)) 
     19    *Q, I(Q), ( dI(Q), dQ(Q) )* 
    2320     
    24 where dQ(Q) is the instrumental resolution in Q and assumed to have originated  
     21where *dQ(Q)* is the instrumental resolution in *Q* and assumed to have originated  
    2522from pinhole geometry. 
    2623 
    2724Numbers can be separated by spaces or commas. 
    2825 
    29 SasView recognises the following file extensions: 
     26SasView recognises the following file extensions which are not case-sensitive: 
    3027 
    3128*  .TXT 
    … …  
    3431*  .XML (in canSAS format v1.0 and 1.1) 
    3532 
    36 If using CSV output from, for example, a spreadsheet, ensure that it is not  
    37 using commas as delimiters for thousands. 
     33If using CSV output from, for example, a spreadsheet, ensure that it is not using commas as delimiters for thousands. 
     34 
     35The SasView :ref:`File_Converter_Tool` available in SasView 4.1 onwards can be used to convert data sets with separated *I(Q)* and *Q* files (for example, BSL/OTOKO, and some output from FIT2D and other SAXS-oriented software) into either the canSAS SASXML (XML) format or the NeXus NXcanSAS (HDF5) format. 
    3836 
    3937For a description of the CanSAS/SASXML format see: 
    4038http://www.cansas.org/formats/canSAS1d/1.1/doc/ 
    4139 
     40For a description of the ISIS 1D format see: 
     41http://www.isis.stfc.ac.uk/instruments/loq/software/colette-ascii-file-format-descriptions9808.pdf 
     42 
     43For a description of the NXcanSAS format see: 
     44http://cansas-org.github.io/NXcanSAS/classes/contributed_definitions/NXcanSAS.html 
     45 
     46All the above formats are written by the `Mantid Framework <http://www.mantidproject.org/>`_. 
     47 
    4248For a description of the NIST 1D format see: 
    4349http://danse.chem.utk.edu/trac/wiki/NCNROutput1D_IQ 
    4450 
    45 For a description of the ISIS 1D format see: 
    46 http://www.isis.stfc.ac.uk/instruments/loq/software/colette-ascii-file-format-descriptions9808.pdf 
     51For a description of the BSL/OTOKO format see:  
     52http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/SAXS-Software/CCP13/BSL.html 
    4753 
    4854.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    4955 
    50 2D Formats SANS 
    51 --------------- 
     562D SAS Formats 
     57-------------- 
    5258 
    53 SasView will only read files in the NIST 2D format with the extensions  
    54 .ASC or .DAT 
     59SasView will read ASCII ('text') files in the NIST 2D format (with the extensions .ASC or .DAT) or files in the NeXus NXcanSAS (HDF5) format (with the extension .H5). File extensions are not case-sensitive. Both of these formats are written by the `Mantid Framework <http://www.mantidproject.org/>`_. 
    5560 
    56 Most of the header lines can be removed except the last line, and only the  
    57 first three columns (Qx, Qy, and I(Qx,Qy)) are actually required. 
     61Most of the header lines in the NIST 2D format can actually be removed except the last line, and only the first three columns (*Qx, Qy,* and *I(Qx,Qy)*) are actually required. 
     62 
     63The SasView :ref:`File_Converter_Tool` available in SasView 4.1 onwards can be used to convert data sets in the 2D BSL/OTOKO format into the NeXus NXcanSAS (HDF5) format. 
    5864 
    5965For a description of the NIST 2D format see: 
    6066http://danse.chem.utk.edu/trac/wiki/NCNROutput1D_2DQxQy  
    6167 
    62 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     68For a description of the NXcanSAS format see:  
     69http://cansas-org.github.io/NXcanSAS/classes/contributed_definitions/NXcanSAS.html 
    6370 
    64 SESANS Format 
    65 ------------- 
    66  
    67 The current file extension is .ses or .sesans (not case sensitive). 
    68  
    69 The file format is to have a list of name-value pairs as a header at the top of the file, detailing general experimental parameters necessary for fitting and analyzing data. This list should contain all information necessary for the file to be 'portable' between users. 
    70  
    71 Following that is a 6 column list of instrument experimental variables: 
    72  
    73 - Spin echo length (z, in Angstroms) 
    74 - Spin echo length error (:math:`\Delta` z, in Angstroms) (experimental resolution) 
    75 - neutron wavelength (:math:`\lambda`, in Angstroms) (essential for ToF instruments) 
    76 - neutron wavelength error (:math:`\Delta \lambda`, in Angstroms) 
    77 - Normalized polarization (:math:`P/P_0`, unitless) 
    78 - Normalized polarization error (:math:`\Delta(P/P_0)`, unitless) (measurement error) 
     71For a description of the BSL/OTOKO format see: For a description of the BSL/OTOKO format see:  
     72http://www.diamond.ac.uk/Beamlines/Soft-Condensed-Matter/small-angle/SAXS-Software/CCP13/BSL.html 
    7973 
    8074 
    8175.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    8276 
    83 .. note::  This help document was last changed by Wim Bouwman, 05Oct2016 
     771D SESANS Format 
     78---------------- 
     79 
     80SasView version 4.1 onwards will read ASCII ('text') files in a prototype SESANS standard format (with the extensions .SES or .SESANS). The file extensions are not case-sensitive. 
     81 
     82The file format has a list of name-value pairs at the top of the file which detail the general experimental parameters necessary for fitting and analyzing data. This list should contain all the information necessary for the file to be 'portable' between users. 
     83 
     84Following the header is a 6 column list of instrument experimental variables: 
     85 
     86- Spin echo length (z, in Angstroms) 
     87- Spin echo length error (:math:`\Delta`\ z, in Angstroms) (experimental resolution) 
     88- Neutron wavelength (:math:`\lambda`, in Angstroms) (essential for ToF instruments) 
     89- Neutron wavelength error (:math:`\Delta \lambda`, in Angstroms) 
     90- Normalized polarization (:math:`P/P_0`, unitless) 
     91- Normalized polarization error (:math:`\Delta(P/P_0)`, unitless) (measurement error) 
     92 
     93.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     94 
     95.. note::  This help document was last changed by Steve King, 07Oct2016 
Note: See TracChangeset for help on using the changeset viewer.