source: sans/Release/trunk/Install_Instructions.txt @ 386

Last change on this file since 386 was 386, checked in by srkline, 14 years ago

Merging revisions 382:HEAD (=385) into the release branch for version 6.010

File size: 5.9 KB
Line 
1To install the NCNR Reduction and Analysis Package:
2
3(1) - Unzip the downloaded package
4(2) - Double click on the NCNR_Install_or_Update.pxp experiment
5(3) - If there are any help files open, you will be asked to close them. NOTE: be sure to hold down the option (or alt) key when closing them to kill them, not just hide them.
6(4) - Click on "Install SANS Macros"
7(5) - When the installer is finished, you will be asked to Quit Igor (yes, do it, and save changes to the experiment.)
8(6) - If you were informed that some folders did not have proper permissions, skip down to the section for "Manual Install"
9
10- SANS_Reduction, USANS_Reduction, and Analysis templates are located in the same folder as the installer (these are the starting points)
11- Example data for reduction and analysis are in NCNR_SANS_Utilities
12- A folder with instructions and a template for writing your own analysis function is included (Single_Model_Template)
13- Help files are integral to each template. Open any of the templates and click on "Help" or "?" from any of the panels to view the help files.
14- Any previous installations, including any files you may have modified are moved to the NCNR_Moved_Files folder. Look in here for anything that you may want to save.
15
16
17To Update the Package:
18
19(1) - double click on the NCNR_Install_or_Update.pxp experiment
20(2) - Click on "Check for Updates"
21(3) - The updater will check the version installed versus the version available on the NCNR website. If your version is out-of-date, you will be sent to the NCNR website.
22(4) If you need to update, download the current version (.zip), and run the installer as in the first step.
23
24
25Troubleshooting:
26
27(1) - double click on the NCNR_Install_or_Update.pxp experiment
28(2) - Click on "Print Diagnostics"
29(3) - Select and copy the entire contents of the notebook of diagnostics, and paste it into an e-mail.
30
31
32-------------------------------------------------------------------
33*** Manual Install of the NCNR SANS/USANS Procedures ***
34-------------------------------------------------------------------
35
36If you were directed by the installer to perform a manual install, it is most likely because you do not have the proper permissions to copy the files into the necessary subfolders of the Igor Pro application folder.
37
38-------------------
39First, if possible, contact your system administrator. See if it is possible to grant you full read/write access to these three folders:
40
41(on Windows)
42/Program Files/WaveMetrics/Igor Pro/Igor Help Files
43/Program Files/WaveMetrics/Igor Pro/Igor Extensions
44/Program Files/WaveMetrics/Igor Pro/User Procedures
45
46(on Mac OSX)
47/Applications/Igor Pro/Igor Help Files
48/Applications/Igor Pro/Igor Extensions
49/Applications/Igor Pro/User Procedures
50
51If you or someone can reset the permissions on these folders so you can read and write, then re-run the installer, and it should work correctly without errors.
52
53
54If you can't get full permissions, you may still be able to use the macros. You must have at a minimum, permission to install in /User Procedures. If you can't get permission to install into /Igor Help Files, you can still open the help files manually as needed. If you can't get permission to install into /Igor Extensions, your calculations will be much slower, and you will not have access to any of the 2D analysis functions.
55
56------------------
57
58If you want to move the files and folders by hand, follow these steps, skipping those operations that you do not have permission to do:
59
60(0) Quit Igor, if it is open.
61
62(1) Clean out ALL of the older versions of the NCNR macros from the User Procedures folder. Move them to the trash/recycle, and be sure to EMPTY the trash/recycle. The files to remove will have a variety of names. See the listing at the bottom of this file.
63
64(2) Clean out all of the older versions of the NCNR Help Files from the Igor Help Files folder. Move them to the trash/recycle, and be sure to EMPTY the trash/recycle. Again, see the listing of possible names at the bottom of this file.
65
66(3) Clean out all of the older versions of the NCNR Extensions from the Igor Extensions folder. Move them to the trash/recycle, and be sure to EMPTY the trash/recycle. Again, see the listing of possible names at the bottom of this file.
67
68(4) From the downloaded package, move the entire folder NCNR_User_Procedures to the Igor Pro/User Procedures folder.
69
70(5) Move the entire folder NCNR_Help_Files to the Igor Pro/Igor Help Files folder.
71
72(6) In the NCNR_Extensions folder, move EITHER the Mac_XOP folder or the Win_XOP folder to Igor Pro/Igor Extensions, depending on your operating system. Delete the XOP for the platform that you are not using.
73
74(7) The NCNR_SANS_Utilities folder has the three templates for starting SANS or USANS Reduction experiment, and for an analysis experiment. If the templates open up correctly, you're likely OK. In this folder, there are also example data sets and a template for writing your own analysis model.
75
76
77-------------------
78"OLD" User Procedures could be any of the following:
79
80SANS_Reduction_v5.00
81SANS_Reduction_v5.0
82SANS Redn 28OCT03
83SANS Redn 18JUN04
84SANS Redn 23JAN04
85SANS Redn Beta
86SANS_Models_B 09MAY03
87SANS_Models (B)
88SANS_Models Beta
89SANS_Models Beta2
90SANS_Models_v3.00
91SANS_Models_v3.01
92USANS Procedures 13AUG02
93USANS_Procedures_14DEC04
94USANS_Procedures_15DEC05
95USANS Beta Procedures
96USANS Procedures v2.00
97USANS Procedures v2.20
98Put in User Procedures
99NCNR_User_Procedures
100NCNR_Extensions
101NCNR_Help_Files
102
103-------------------
104"OLD" Igor Help files could be any of the following:
105
106SANS_Reduction_Help_v5.ihf
107SANSReductionHelp_4p2.ihf
108SANS_Analysis_Docs_v3.00.ihf
109SANSAnalysisHelp(B).ihf
110SANS_Model_Docs_v3.00.ihf
111SANS_Model_Docs_v3.01.ihf
112USANSReductionHelp_v2.20.ihf
113USANSReductionHelp_v2.00.ihf
114USANSReductionHelp_v1.ihf
115SANS_Analysis_Docs_09JUN06.ihf
116SANS_Model_Docs_09JUN06.ihf
117Put in Igor Help Files
118NCNR_Help_Files
119
120-------------------
121"OLD" Igor Extensions could be any of the following:
122
123SANS_Analysis.xop
124NCNR_Extensions
125Mac_XOP
126Win_XOP
127-------------------
128
129
130
131
132June 2008 SRK
Note: See TracBrowser for help on using the repository browser.