Added INSTALL instructions.

This commit is contained in:
Sylvain Tricot 2022-03-07 16:26:19 +01:00
parent 20b7716f4a
commit a073dc1520
1 changed files with 45 additions and 0 deletions

45
INSTALL.md Normal file
View File

@ -0,0 +1,45 @@
Building MsSpec_DFM
===================
To build MsSpec_DFM, you need a fortran compiler (gfortran), python > 3.6 and pip
Getting the source code
-----------------------
To download the source code, you can clone the git repo of the project
```
$ git clone https://git.ipr.univ-rennes1.fr/epsi/MsSpec-DFM.git
```
If git is not avilable on your system, you can download a compressed archive
on the [repo website](https://git.ipr.univ-rennes1.fr/epsi/MsSpec-DFM).
Once downloaded, this archive should be uncompressed.
Building and installing
-----------------------
```
# Change to the src folder
$ cd MsSpec-DFM/src
# Type in 'make' or 'make all'
$ make
# This will install the commandline utility and python bindings
$ make install
```
Every new Python packages and dependencies will be installed in the
Python user site packages (under $HOME/.local/ tree).
You can also use a Python virtual environment
Uninstalling
------------
```
$ pip uninstall msspec_dfm
```