From 47a172f94b141e66c2f446a60f1034e539db1f2b Mon Sep 17 00:00:00 2001 From: affanadly <89124642+affanadly@users.noreply.github.com> Date: Sat, 2 Apr 2022 10:48:17 +0800 Subject: [PATCH] Update README.md --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 48 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 56b3030..daff90e 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,53 @@ This is a bash script intended to install ATNF's Miriad radio interferometry dat * `zlib1g` ## Steps: -1. Download the `install.sh` -2. Open the terminal in the folder containing the file and run `chmod u+x install.sh` -3. Run the script using `./install.sh` +1. Download and unpack the archive into a directory of choice: + ``` + unzip Miriad-Duchamp-Installer-[version].zip + ``` + or + ``` + tar -xzvf Miriad-Duchamp-Installer-[version].tar.gz + ``` + where `[version]` is the downloaded version of the installer. This will unpack the files into a directory called `Miriad-Duchamp-Installer-[version]`. +2. Enter the directory using + ``` + cd Miriad-Duchamp-Installer-[version] + ``` +3. Make the installer script an executable using + ``` + chmod u+x installer.sh + ``` +4. Run the script using + ``` + ./installer.sh + ``` + Note: You may need to enter your password here for sudo privileges. +5. If there are no errors and you see the message + ``` + "Installation complete. Run source ~/.profile or restart to use Miriad." + ``` + the installation is successful. Run `source ~/.profile` or restart the machine. +6. To test the installation, open another terminal and run `miriad` and you should see + ``` + Miriad shell version 1.5, 2007/06/12 + + miriad% + ``` + and to test Duchamp, run `Duchamp` and you should see + ``` + Usage: Duchamp [OPTION] [FILE] + Duchamp is an object finder for spectral-line FITS cubes. + + -p FILE Read in parameters from FILE, including FITS image location. + -f FILE Use default parameters with imageFile=FILE + -t THRESH Sets the detection threshold to THRESH, overriding that given by the parameter file. + -x Do not use X-windows PGPLOT output + (equivalent to setting flagXOutput=false -- overrides the parameter file) + + -v Return version number and exit + -h Display this help information and exit + ``` ## Disclaimer: -I do not own any of the softwares involved in the script. The copyrights of every software involved can be found at their respective homepages. This is written just to ease the installation process of these softwares. +I do not own any of the softwares involved in the script. The copyrights and licenses of every software involved can be found at their respective homepages. This is written just to ease the installation process of these softwares.