Installation

From FITSH
(Difference between revisions)
Jump to: navigation, search
m
m
 
(10 intermediate revisions by one user not shown)
Line 1: Line 1:
 
__NOTOC__  
 
__NOTOC__  
By default, the FITSH package does not have any specific dependence. You only have a C compiler (e.g. [http://gcc.gnu.org/ GCC]) and the related standard development headers (that are usually placed in the directory /usr/include) on your system. See also the list of [[#Supported operating systems|supported operating systems and architectures]] below.
+
By default, the '''FITSH''' package does not have any specific dependence. You only have a C compiler (e.g. [http://gcc.gnu.org/ GCC]) and the related standard development headers (that are usually placed in the directory /usr/include) on your system. See also the list of [[#Supported operating systems|supported operating systems and architectures]] below.
  
 +
Here we detail how '''FITSH''' can be installed:
 +
* system-wide,
 +
* for a single user, or
 +
* using a deb(ian) based package manager.
 +
In principle, '''FITSH''' do not need any special privileges on the host computer, so all of the features are instantly available for a non-privileged normal user. System-wide and package-based installation simplifies the access to '''FITSH''' tasks for all of the users having an access to the computer in general.
 
In this description below, the commands beginning with the prompt <code># ...</code> refer to commands needed to be issued by the root (i.e. system administrator) while commands beginning with the prompt <code>$ ...</code> can be run without any specific privileges.
 
In this description below, the commands beginning with the prompt <code># ...</code> refer to commands needed to be issued by the root (i.e. system administrator) while commands beginning with the prompt <code>$ ...</code> can be run without any specific privileges.
  
 
=== System-wide installation ===
 
=== System-wide installation ===
  
The current stable version of the program is '''0.9.1''', you can browse the available versions [http://fitsh.net/release here]. Instailling the package from the source tarball might go as follows. After extracting the archive, by entering simply (for the latest version):
+
The current stable version of the program is '''<version/>''', you can browse the available versions [http://fitsh.net/release here]. Instailling the package from the source tarball might go as follows. After extracting the archive, by entering simply (for the latest version):
  
<nowiki>
+
<ul class="root">
# cd /usr/src
+
<li>cd /usr/src
# wget http://fitsh.net/download/fitsh/fitsh-0.9.1.tar.gz
+
<li>wget http<span></span>://fitsh.net/download/fitsh/fitsh-<version/>.tar.gz
# tar xvzf fitsh-0.9.1.tar.gz</nowiki>
+
<li>tar xvzf fitsh-<version/>.tar.gz
 +
</ul>
  
Then, go to the appropriate sub-directory ('''fitsh-0.9.1''', by issuing <code>cd fitsh-0.9.1</code>), and run the standard <code>configure && make</code> procedure, i.e.:
+
Then, go to the appropriate sub-directory ('''fitsh-<version/>''', by issuing <code>cd fitsh-<version/></code>), and run the standard <code>configure && make</code> procedure, i.e.:
  
<nowiki>
+
<ul class="root">
# cd fitsh-0.9.1
+
<li>cd fitsh-<version/>
# ./configure</nowiki>
+
<li>./configure
 +
</ul>
  
 
which is followed by
 
which is followed by
  
<nowiki># make</nowiki>
+
<ul class="root">
 +
<li>make
 +
</ul>
  
 
After a successful compilation, the binaries and some related libraries might be installed into the target filesystem hierarchy location by entering
 
After a successful compilation, the binaries and some related libraries might be installed into the target filesystem hierarchy location by entering
  
<nowiki># make install</nowiki>
+
<ul class="root">
 +
<li>make install
 +
</ul>
  
 
The "root" of the filesystem hierarchy is the <code>/usr/local</code> directory by default. In order to place the binaries to another location, use an alternative '''prefix''' for <code>./configure</code>, for instance:
 
The "root" of the filesystem hierarchy is the <code>/usr/local</code> directory by default. In order to place the binaries to another location, use an alternative '''prefix''' for <code>./configure</code>, for instance:
  
<nowiki># ./configure --prefix=/opt</nowiki>
+
<ul class="root">
 +
<li>./configure --prefix=/opt
 +
</ul>
  
 
=== Local installation for a single user ===
 
=== Local installation for a single user ===
Line 35: Line 48:
 
If you do not have rights on the computer for system administration, i.e. you cannot install anything under <code>/opt</code> or </code>/usr/local</code>, you can safely use your home directory (or a subdirectory in it) in order to install the package. Supposing that your username is '''myuser''' (see also the output of the <code>whoami</code> command) and your home directory is <code>/home/myuser</code>, simply type
 
If you do not have rights on the computer for system administration, i.e. you cannot install anything under <code>/opt</code> or </code>/usr/local</code>, you can safely use your home directory (or a subdirectory in it) in order to install the package. Supposing that your username is '''myuser''' (see also the output of the <code>whoami</code> command) and your home directory is <code>/home/myuser</code>, simply type
  
<nowiki>$ ./configure --prefix=/home/myuser/usr</nowiki>
+
<ul class="user">
 +
<li>./configure --prefix=/home/myuser/usr
 +
</ul>
  
 
The installation procedure (see <code>make install</code> above) will then create the subdirectories <code>/home/mysuer/usr/bin</code>, <code>/home/mysuer/usr/lib</code> and <code>/home/mysuer/usr/include</code> where the task binaries, <code>lfit</code> shared objects and <code>lfit</code> module headers are installed, respectively. In this case, you should put the directory <code>/home/mysuer/usr/bin</code> into your path in order to access the FITSH tasks from everywhere (at least, from your account). Follow your shell's guidelines to do so, if you use the bash shell, put something similar into your <code>~/.bashrc</code> file:
 
The installation procedure (see <code>make install</code> above) will then create the subdirectories <code>/home/mysuer/usr/bin</code>, <code>/home/mysuer/usr/lib</code> and <code>/home/mysuer/usr/include</code> where the task binaries, <code>lfit</code> shared objects and <code>lfit</code> module headers are installed, respectively. In this case, you should put the directory <code>/home/mysuer/usr/bin</code> into your path in order to access the FITSH tasks from everywhere (at least, from your account). Follow your shell's guidelines to do so, if you use the bash shell, put something similar into your <code>~/.bashrc</code> file:
Line 45: Line 60:
 
If the [http://packages.debian.org/stable/dpkg DPKG packaging system] and the [http://www.gnu.org/software/help2man/ help2man] utility is installed on your system, you can use the target
 
If the [http://packages.debian.org/stable/dpkg DPKG packaging system] and the [http://www.gnu.org/software/help2man/ help2man] utility is installed on your system, you can use the target
  
<nowiki>$ make deb</nowiki>
+
<ul class="user">
 +
<li>make deb
 +
</ul>
  
 
to create a Debian package. In order to install this newly created package, use the command [http://packages.debian.org/stable/dpkg dpkg]:
 
to create a Debian package. In order to install this newly created package, use the command [http://packages.debian.org/stable/dpkg dpkg]:
  
<nowiki># dpkg --install ./fitsh_0.9.1_amd64.deb</nowiki>
+
<ul class="root">
 +
<li>dpkg --install ./fitsh_<version/>_amd64.deb
 +
</ul>
  
or use your alternative/favourite Debian package manager. Note that the newly created Debian package is always placed into the root of the source tree. Note also that while the <code>make deb</code> target doesn't require root privileges, the <code>dpkg --install ...</code> does so.  
+
or use your alternative/favourite Debian package manager. Note that the newly created Debian package is always placed into the root of the source tree. Note also that while the <code>make deb</code> target doesn't require root privileges, the <code>dpkg --install ...</code> does so.
  
 
=== Supported operating systems ===
 
=== Supported operating systems ===
  
 
During the development of the FITSH package, it was tested under the following operating systems and architectures:
 
During the development of the FITSH package, it was tested under the following operating systems and architectures:
* Debian GNU/Linux, specifically releases lenny and squeeze, both on i386 and amd64 architectures. This is also the primary development platform of the package.
+
* [http://www.debian.org/ Debian GNU/Linux], specifically releases lenny, squeeze, wheezy and jessie. All of these are tested on i386 and amd64 architectures. This is also the primary development platform of the package.
* NetBSD, release 5.0.2 on i386 architecture.
+
* [http://www.netbsd.org/ NetBSD], release 5.0.2 on i386 architecture.
* Mac OS X, release 10.6.8 (``Snow Leopard'').
+
* [http://www.apple.com/macosx/ Mac OS X], release 10.6.8 ("Snow Leopard").
The complier was always the system default C compiler from the GNU Compiler Collection (GCC). Since the primary development platfrom is Debian, some compilation-time warnings may occur on other operating systems (even on the above ones).
+
The complier was always the system default C compiler from the GNU Compiler Collection ([http://gcc.gnu.org/ GCC]). Since the primary development platfrom is Debian, some compilation-time warnings may occur on other operating systems.

Latest revision as of 12:03, 9 November 2016

By default, the FITSH package does not have any specific dependence. You only have a C compiler (e.g. GCC) and the related standard development headers (that are usually placed in the directory /usr/include) on your system. See also the list of supported operating systems and architectures below.

Here we detail how FITSH can be installed:

  • system-wide,
  • for a single user, or
  • using a deb(ian) based package manager.

In principle, FITSH do not need any special privileges on the host computer, so all of the features are instantly available for a non-privileged normal user. System-wide and package-based installation simplifies the access to FITSH tasks for all of the users having an access to the computer in general. In this description below, the commands beginning with the prompt # ... refer to commands needed to be issued by the root (i.e. system administrator) while commands beginning with the prompt $ ... can be run without any specific privileges.

[edit] System-wide installation

The current stable version of the program is 0.9.2, you can browse the available versions here. Instailling the package from the source tarball might go as follows. After extracting the archive, by entering simply (for the latest version):

  • cd /usr/src
  • wget http://fitsh.net/download/fitsh/fitsh-0.9.2.tar.gz
  • tar xvzf fitsh-0.9.2.tar.gz

Then, go to the appropriate sub-directory (fitsh-0.9.2, by issuing cd fitsh-0.9.2), and run the standard configure && make procedure, i.e.:

  • cd fitsh-0.9.2
  • ./configure

which is followed by

  • make

After a successful compilation, the binaries and some related libraries might be installed into the target filesystem hierarchy location by entering

  • make install

The "root" of the filesystem hierarchy is the /usr/local directory by default. In order to place the binaries to another location, use an alternative prefix for ./configure, for instance:

  • ./configure --prefix=/opt

[edit] Local installation for a single user

If you do not have rights on the computer for system administration, i.e. you cannot install anything under /opt or /usr/local, you can safely use your home directory (or a subdirectory in it) in order to install the package. Supposing that your username is myuser (see also the output of the whoami command) and your home directory is /home/myuser, simply type

  • ./configure --prefix=/home/myuser/usr

The installation procedure (see make install above) will then create the subdirectories /home/mysuer/usr/bin, /home/mysuer/usr/lib and /home/mysuer/usr/include where the task binaries, lfit shared objects and lfit module headers are installed, respectively. In this case, you should put the directory /home/mysuer/usr/bin into your path in order to access the FITSH tasks from everywhere (at least, from your account). Follow your shell's guidelines to do so, if you use the bash shell, put something similar into your ~/.bashrc file:

export PATH=/home/mysuer/usr/bin:${PATH}

[edit] Install as a Debian package

If the DPKG packaging system and the help2man utility is installed on your system, you can use the target

  • make deb

to create a Debian package. In order to install this newly created package, use the command dpkg:

  • dpkg --install ./fitsh_0.9.2_amd64.deb

or use your alternative/favourite Debian package manager. Note that the newly created Debian package is always placed into the root of the source tree. Note also that while the make deb target doesn't require root privileges, the dpkg --install ... does so.

[edit] Supported operating systems

During the development of the FITSH package, it was tested under the following operating systems and architectures:

  • Debian GNU/Linux, specifically releases lenny, squeeze, wheezy and jessie. All of these are tested on i386 and amd64 architectures. This is also the primary development platform of the package.
  • NetBSD, release 5.0.2 on i386 architecture.
  • Mac OS X, release 10.6.8 ("Snow Leopard").

The complier was always the system default C compiler from the GNU Compiler Collection (GCC). Since the primary development platfrom is Debian, some compilation-time warnings may occur on other operating systems.

Personal tools