Work on documentation:installation section
epsi-builds/msspec_python3/pipeline/head There was a failure building this commit
Details
epsi-builds/msspec_python3/pipeline/head There was a failure building this commit
Details
This commit is contained in:
parent
d520405a73
commit
7ebd1d25e2
|
|
@ -14,8 +14,8 @@ pipeline {
|
||||||
}
|
}
|
||||||
stage('Syncing website...') {
|
stage('Syncing website...') {
|
||||||
steps {
|
steps {
|
||||||
sh 'rm -rf $HOME/www/*'
|
// sh 'rm -rf $HOME/www/*'
|
||||||
sh 'cp -a ./doc/build/html/* $HOME/www/'
|
// sh 'cp -a ./doc/build/html/* $HOME/www/'
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -44,7 +44,6 @@ clean:
|
||||||
@rm -f source/spectroscopies/common_parameters.inc
|
@rm -f source/spectroscopies/common_parameters.inc
|
||||||
@rm -f source/spectroscopies/ped/ped_parameters.inc
|
@rm -f source/spectroscopies/ped/ped_parameters.inc
|
||||||
@rm -f source/spectroscopies/eig/eig_parameters.inc
|
@rm -f source/spectroscopies/eig/eig_parameters.inc
|
||||||
@rm -f source/downloads.rst
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -258,7 +258,7 @@ texinfo_documents = [
|
||||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||||
#texinfo_show_urls = 'footnote'
|
#texinfo_show_urls = 'footnote'
|
||||||
|
|
||||||
custom.generate_download_page()
|
#custom.generate_download_page()
|
||||||
custom.generate_parameters()
|
custom.generate_parameters()
|
||||||
custom.generate_parameters(spectroscopy='PED')
|
custom.generate_parameters(spectroscopy='PED')
|
||||||
custom.generate_parameters(spectroscopy='EIG')
|
custom.generate_parameters(spectroscopy='EIG')
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,55 @@
|
||||||
|
##########################
|
||||||
|
Download and install notes
|
||||||
|
##########################
|
||||||
|
|
||||||
|
|
||||||
|
click :download:`here <https://msspec.cnrs.fr/downloads/msspec_latest.tar.gz>` to download the last version of MsSpec
|
||||||
|
|
||||||
|
|
||||||
|
************
|
||||||
|
Installation
|
||||||
|
************
|
||||||
|
|
||||||
|
|
||||||
|
There are 2 ways to install MsSpec. You can either:
|
||||||
|
- Use a Docker image
|
||||||
|
- Compile your own version
|
||||||
|
|
||||||
|
|
||||||
|
Using a Docker image
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
You first need Docker (Docker Desktop) to be installed on your system.
|
||||||
|
This is really straightforward. Please see the `Docker website
|
||||||
|
<https://www.docker.com>`_ for more information.
|
||||||
|
|
||||||
|
You the need to load the MsSpec Docker image. For this step you can either:
|
||||||
|
|
||||||
|
- download the image (a \*.tar.gz file) from the
|
||||||
|
`MsSpec website <https://msspec.cnrs.fr>`_
|
||||||
|
and then load it into Docker
|
||||||
|
::
|
||||||
|
docker load < msspec_latest.tar.gz
|
||||||
|
|
||||||
|
|
||||||
|
- pull the image from our repository:
|
||||||
|
::
|
||||||
|
docker pull msspec:latest
|
||||||
|
|
||||||
|
That's all. MsSpec is installed. Now the command to launch the MsSpec environment depends slighly on the
|
||||||
|
OS you are runing:
|
||||||
|
|
||||||
|
- For Linux
|
||||||
|
::
|
||||||
|
xhost +
|
||||||
|
docker run --rm -it -e DISPLAY=$DISPLAY --net=host -v msspec_data:/home/msspec/data msspec
|
||||||
|
|
||||||
|
- For Windows
|
||||||
|
::
|
||||||
|
docker run --rm -it -e DISPLAY=host.internal.display:0 -v msspec_data:/home/msspec/data msspec
|
||||||
|
|
||||||
|
|
||||||
|
Compile your own version
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
To install MsSpec this way, follow the instructions `here <https://git.ipr.univ-rennes1.fr/epsi/msspec_python3/src/branch/devel>`_
|
||||||
|
|
@ -2,123 +2,46 @@
|
||||||
Installation
|
Installation
|
||||||
************
|
************
|
||||||
|
|
||||||
.. |logowin| image:: windows_icon.png
|
|
||||||
:height: 96px
|
|
||||||
:target: `win10_install_notes`_
|
|
||||||
|
|
||||||
.. |logolinux| image:: linux_icon.png
|
There are 2 ways to install MsSpec. You can either:
|
||||||
:height: 96px
|
- Use a Docker image
|
||||||
:target: `linux_install_notes`_
|
- Compile your own version
|
||||||
|
|
||||||
.. |logomac| image:: apple_icon.png
|
|
||||||
:height: 96px
|
|
||||||
:target: `mac_install_notes`_
|
|
||||||
|
|
||||||
|
|
||||||
|
Using a Docker image
|
||||||
|
--------------------
|
||||||
|
|
||||||
.. admonition:: Select your Operating System to view specific installation instructions
|
You first need Docker (Docker Desktop) to be installed on your system.
|
||||||
|
This is really straightforward. Please see the `Docker website
|
||||||
|
<https://www.docker.com>`_ for more information.
|
||||||
|
|
||||||
|logowin| |logolinux| |logomac|
|
You the need to load the MsSpec Docker image. For this step you can either:
|
||||||
|
|
||||||
|
- download the image (a \*.tar.gz file) from the
|
||||||
|
`MsSpec website <https://msspec.cnrs.fr>`_
|
||||||
|
and then load it into Docker
|
||||||
|
::
|
||||||
|
docker load < msspec_latest.tar.gz
|
||||||
|
|
||||||
|
|
||||||
.. _common_install_notes:
|
- pull the image from our repository:
|
||||||
|
::
|
||||||
|
docker pull msspec:latest
|
||||||
|
|
||||||
In a terminal window, execute the setup program you've just downloaded.
|
That's all. MsSpec is installed. Now the command to launch the MsSpec environment depends slighly on the
|
||||||
|
OS you are runing:
|
||||||
|
|
||||||
.. code-block:: console
|
- For Linux
|
||||||
|
::
|
||||||
|
xhost +
|
||||||
|
docker run --rm -it -e DISPLAY=$DISPLAY --net=host -v msspec_data:/home/msspec/data msspec
|
||||||
|
|
||||||
$ sh ./MsSpec-version.setup
|
- For Windows
|
||||||
|
::
|
||||||
Once the install process has competed, you can launch the MsSpec environnement by typing::
|
docker run --rm -it -e DISPLAY=host.internal.display:0 -v msspec_data:/home/msspec/data msspec
|
||||||
|
|
||||||
msspec
|
|
||||||
|
|
||||||
|
|
||||||
|
Compile your own version
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
To install MsSpec this way, follow the instructions `here <https://git.ipr.univ-rennes1.fr/epsi/msspec_python3/src/branch/devel>`_
|
||||||
.. _win10_install_notes:
|
|
||||||
|
|
||||||
For Windows 10
|
|
||||||
==============
|
|
||||||
|
|
||||||
Windows users can install MsSpec through the Windows Subsystem for Linux
|
|
||||||
(also known as bash Ubuntu).
|
|
||||||
|
|
||||||
Below is a short description of the steps to enable this feature. You can
|
|
||||||
have more details `here <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_.
|
|
||||||
|
|
||||||
Install the Windows Subsystem for Linux
|
|
||||||
---------------------------------------
|
|
||||||
|
|
||||||
1. Turn on Developer Mode
|
|
||||||
Open **Settings -> Update and Security -> For developers**
|
|
||||||
|
|
||||||
.. figure:: win_step1.png
|
|
||||||
:align: center
|
|
||||||
:width: 70%
|
|
||||||
|
|
||||||
Select the Developer Mode radio button
|
|
||||||
|
|
||||||
2. Open a command prompt. Run::
|
|
||||||
|
|
||||||
bash
|
|
||||||
|
|
||||||
.. figure:: win_step2.png
|
|
||||||
:align: center
|
|
||||||
:width: 70%
|
|
||||||
|
|
||||||
Type "y" to accept the license. An Ubuntu system will be installed.
|
|
||||||
|
|
||||||
|
|
||||||
3. Launch a new Ubuntu shell by running *bash* from the command prompt.
|
|
||||||
If this is the first time that the Windows Subsystem for Linux is installed,
|
|
||||||
you will be prompted to create a UNIX user. Simply follow the instructions.
|
|
||||||
This UNIX username and password may be different from your Windows username
|
|
||||||
and password.
|
|
||||||
|
|
||||||
Install an X server
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
To allow graphical windows to popup in this Linux environnement, you need to install
|
|
||||||
an X server. **Xming** is a good choice. Go to `this website <http://www.straightrunning.com/XmingNotes/>`_
|
|
||||||
and download and install the public version 6.9.0.31.
|
|
||||||
|
|
||||||
Don't forget to start the server after the install. You can configure it to always run automatically at
|
|
||||||
the startup.
|
|
||||||
|
|
||||||
Install MsSpec
|
|
||||||
--------------
|
|
||||||
|
|
||||||
Open a Windows command prompt and launch *bash*. For the Xming server to work, you need to modify
|
|
||||||
the DISPLAY environnement variable. Enter this command::
|
|
||||||
|
|
||||||
echo "export DISPLAY=:0" >> ~/.bashrc && source ~/.bashrc
|
|
||||||
|
|
||||||
Then you can launch the setup program::
|
|
||||||
|
|
||||||
cd /where/the/setup/program/was/downloaded
|
|
||||||
sh ./MsSpec-version.setup
|
|
||||||
|
|
||||||
where *version* is the actual version number
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. _linux_install_notes:
|
|
||||||
|
|
||||||
For Linux
|
|
||||||
=========
|
|
||||||
|
|
||||||
Ubuntu and Mageia based dstributions are supported by the installer, but any Linux
|
|
||||||
flavour should be able to run MsSpec as long as you have permissions to install
|
|
||||||
all requirements.
|
|
||||||
|
|
||||||
You just need to open a terminal window and execute the setup program.
|
|
||||||
|
|
||||||
|
|
||||||
.. _mac_install_notes:
|
|
||||||
|
|
||||||
For Mac 0S
|
|
||||||
==========
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
to be written...
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue