Changeset 187a4a07 in sasview for installers

Timestamp:

Sep 10, 2018 10:40:50 AM (6 years ago)

Author:

smk78

Branches:

master, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, unittest-saveload

Children:

d15ce7c6

Parents:

aa1e5a69

Message:

Attempt at cleaning up Installation instructions

File:

• installers/README-next-release.txt (modified) (6 diffs)

installers/README-next-release.txt

@@ -198 +198 @@
       attention is drawn to the Changes section above.
 
+
     - New in Version 4.2.0-Beta
       -------------------------
@@ -229 +230 @@
       It is recommended that all users upgrade to this version
 
+
     - New in Version 4.1.1
       --------------------
@@ -241 +243 @@
        - Fixes an issue with the NXcanSAS data loader
        - Updated tutorials for SasView 4.x.y
+
 
     - New in Version 4.1.0
@@ -646 +649 @@
 =============================
 
-   *** Note 1:  The easiest approach to setting up the proper environment to
-                build from source is to use conda.  Instructions for setting up
-                and using conda can be found at:
-                    http://trac.sasview.org/wiki/DevNotes/CondaDevSetup
-   *** Note 2:  If you have EXE or ZIP SasView installer, you won't need any of
-                the following.  However it is highly recommended that any
-                previous versions be un-installed prior to installing the
-                new version.
-   *** Note 3:  Much more information is available at www.sasview.org under links.
-                Look in the 'For Developers' section and particularly the wiki at
-                www.sasview.org/trac/wiki.
+   *** Note 1:  If you have a SasView installer (.EXE or .MSI), you do not need to 
+                worry about any of the following.  However, it is highly recommended 
+                that any previous versions of SasView are uninstalled prior to 
+                installing the new version UNLESS you are installing SasView to 
+                versioned folders.
+
+   *** Note 2:  The easiest approach to setting up the proper environment to
+                build from source is to use Conda.  Instructions for setting up
+                and using Conda can be found at:
+                  http://trac.sasview.org/wiki/DevNotes/CondaDevSetup
+                    
+   *** Note 3:  Much more information is available at www.sasview.org under 
+                links/downloads. In particular, look in the 'For Developers' section. 
+                Also have a look at http://trac.sasview.org/.
 
    2.1- System Requirements
@@ -662 +668 @@
         - We currently use Python 2.7
 
-   2.2- Installing from source
+   2.2- Package Dependencies
+        - Ensure the required dependencies are installed
+          - For the latest list of dependencies see the appropriate yml file in
+            the SasView repo at sasview/build_tools/conda/ymls
+
+   2.3- Installing from Source
         - Get the source code
-          - to follow the current development version from source control use
-              git clone https://github.com/SasView/sasview.git
-              git clone https://github.com/Sasview/sasmodels.git
-              git clone https://github.com/bumps/bumps.git
-
-        - Build, install and run a specific release
-          - make sure the requirements below are already installed
-          - retrieve the source from https://github.com/SasView/sasview/releases
-          - open a command line window in the 'sasview-x.x.x' directory
-          - run 'python setup.py install'
-          - run 'python sasview.py' under the 'sasview' folder.
-
-        - Build, install and run the current development version
-          - clone the source from git; also clone bumps, which is developed in parallel
-              git clone https://github.com/SasView/sasview.git
-              git clone https://github.com/Sasview/sasmodels.git
-              git clone https://github.com/bumps/bumps.git
-          - open a command line window in the 'sasview' directory
-          - run 'python setup.py build'
-          - run 'python run.py'; this runs from the source directories, so you
+          - create a folder to contain the source code; if working with
+            multiple versions you might want to use versioned folder names
+            like 'sasview-x.x.x'
+          - open a command line window in the source code folder
+          - to get the CURRENT DEVELOPMENT VERSION from source control use
+              git clone https://github.com/SasView/sasview.git sasview
+              git clone https://github.com/Sasview/sasmodels.git sasmodels
+              git clone https://github.com/bumps/bumps.git bumps
+          - to get a SPECIFIC RELEASE VERSION from source control go to
+              https://github.com/SasView/sasview/releases
+            and download the required zip or tar.gz file. Unzip/untar it
+            to the source code folder.
+
+   2.4- Building and Installing         
+        - use 'python setup.py build'
+        - use 'python setup.py install'
+        To build the documentation
+          - use'python setup.py docs'
+
+   2.5- Running SasView
+          - use 'python run.py'; this runs from the source directories, so you
             don't have to rebuild every time you make a change, unless you are
-            changing the C model files
-
-        - For the latest list of dependencies see the appropriate yml file in
-          the SasView repo at sasview/build_tools/conda/ymls
+            changing the C model files.
+          - if using Conda the above command will also build SasView, but you 
+            must issue 'activate sasview' first.
 
 
@@ -694 +705 @@
 ===============
 
-
-   4.2.0 - All systmes
+   4.2.0 - All systems
       There are currently no major known issues. A full list of known bugs and
       feature requests by release version that users may wish to be aware of