Symbolic links for executables
authorAnthony Stone <ajs1@cam.ac.uk>
Tue, 13 Nov 2018 11:56:28 +0000 (11:56 +0000)
committerAnthony Stone <ajs1@cam.ac.uk>
Tue, 13 Nov 2018 15:43:12 +0000 (15:43 +0000)
.gitignore
INSTALL
Makefile
bin/orient [new symlink]
osx/gfortran/exe/.gitignore
osx/gfortran/exe/orient [new symlink]
x86-64/nagfor/exe/.gitignore

index c90456f..7728842 100644 (file)
@@ -8,7 +8,6 @@ src/version.f90
 *.pl
 doc/figures/adlayer.tex
 **/modfiles
-bin/orient
 bugs/
 src/test_versions
 src/testing
diff --git a/INSTALL b/INSTALL
index aad6664..98e1c7f 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,14 +1,28 @@
 Orient 5.0 Installation
 -----------------------
 
-Installing from source:
-
-1.  In a suitable directory, run the command
+    In a suitable directory, run the command
       git clone https://git.uis.cam.ac.uk/x/ch-stone/u/ajs1/Orient.git
     This will construct a clone of the program files in the
     subdirectory Orient. Change to this directory.
 
-2.  Inspect the variables defined at the top of the Makefile in the
+Installing a precompiled binary:
+
+    In the directories <arch>/<compiler>/exe, where <arch> is x86-64
+    or osx and <compiler> is gfortran or nagfor, there are precompiled
+    binaries orient-5.0.07 and orient-5.0.07-ng. The first of these is
+    the standard version, which requires the OpenGL libraries. It may
+    be necessary to set the LOAD_LIBRARY_PATH environment variable to
+    include the directories containing those libraries. If the
+    graphical display is not required, the orient-5.0.07-ng version
+    can be used. In either case, the recommended procedure is to set a
+    symbolic link orient in /usr/local/bin or your private bin
+    directory pointing to the required version. The test procedure
+    expects a link also from Orient/bin/orient.
+
+Installing from source:
+
+1.  Inspect the variables defined at the top of the Makefile in the
     Orient directory, and correct the values as necessary. You
     may want to set the COMPILER variable to a different value. You
     will also need to check that the paths to the various library
@@ -20,7 +34,7 @@ Installing from source:
     interoperability features, and you need to have the OpenGL
     libraries installed.
 
-3.  Check the settings in the Orient/<arch>/<compiler>/Flags
+2.  Check the settings in the Orient/<arch>/<compiler>/Flags
     file, where <arch> is your machine architecture and operating
     system and <compiler> the compiler that you intend to use. You may
     need to make a directory Orient/<arch>/<compiler> if it
@@ -30,7 +44,7 @@ Installing from source:
     compiler flags. You can copy the Flags file from one of the other
     directories and modify it as necessary.
 
-4.  Change to the Orient directory and run the command 
+3.  Change to the Orient directory and run the command 
 
        make [COMPILER=compiler] [OPENGL=no]
 
@@ -40,11 +54,15 @@ Installing from source:
     the OpenGL libraries, specify OPENGL=no (but they are provided as
     standard under most operating systems).
 
-5.  The Orient executable should appear as
+4.  The Orient executable should appear as
     Orient/<arch>/<compiler>/exe/orient-5.0.nn, with a symbolic link
-    to it from Orient/bin/orient.
+    to it from Orient/bin/orient. If you compile without the OpenGL
+    libraries, the executable will be named orient-5.0.nn-ng.
+    
+
+Testing the installation:
 
-5.  Change to the Orient/tests directory, and run
+    Change to the Orient/tests directory, and run
 
       ./orient_tests.py [-h] [--omit formamide]
 
@@ -55,7 +73,13 @@ Installing from source:
     details of other options that can be used, for example to select
     particular tests.
 
+Updating the installation:
 
+    At any time, you can run the command
+      git pull
+    in the Orient directory. This will install any updates and
+    corrections to the Orient files. It may be necessary to recompile
+    or to link to an updated executable. 
 
 Please notify me of any bugs that you find. Suggestions for fixing
 bugs would be particularly welcome. If you make changes to the source
index b0c375f..b41d262 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -87,7 +87,7 @@ endif
 
 orient:
        mkdir -p ${BASE}/${DIR}; cd ${BASE}/${DIR}; ${MAKE} -f ${BASE}/Makefile orient-${VERSION}.${PATCHLEVEL}${NG} BASE=${BASE}
-       cd ${BASE}/${DIR}; ln -f orient-${VERSION}.${PATCHLEVEL}${NG} orient
+       cd ${BASE}/${DIR}; ln -sf orient-${VERSION}.${PATCHLEVEL}${NG} orient
        ln -sf ${BASE}/${DIR}/orient ${BASE}/bin
 
 orient-${VERSION}.${PATCHLEVEL}${NG}: modules objects
diff --git a/bin/orient b/bin/orient
new file mode 120000 (symlink)
index 0000000..172baae
--- /dev/null
@@ -0,0 +1 @@
+/home/ajs1/Orient/x86-64/gfortran/exe/orient
\ No newline at end of file
index a386cc9..9717940 100644 (file)
@@ -5,3 +5,5 @@
 #  and the current executable binary files
 !orient-5.0.07
 !orient-5.0.07-ng
+# and the link to orient-5.0.07
+!orient
diff --git a/osx/gfortran/exe/orient b/osx/gfortran/exe/orient
new file mode 120000 (symlink)
index 0000000..ba7f54d
--- /dev/null
@@ -0,0 +1 @@
+orient-5.0.07
\ No newline at end of file
index a386cc9..9717940 100644 (file)
@@ -5,3 +5,5 @@
 #  and the current executable binary files
 !orient-5.0.07
 !orient-5.0.07-ng
+# and the link to orient-5.0.07
+!orient