From 81459cfcfcbb1bb0641b1bf05f2cb6cc3379a168 Mon Sep 17 00:00:00 2001 From: Sylvain Tricot Date: Tue, 31 Mar 2020 18:29:41 +0200 Subject: [PATCH] Update doc and README info. --- README.md | 83 ++++++++++---------------------------------- doc/source/title.svg | 2 +- 2 files changed, 19 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index 8f5d6ac..a46d0ed 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,14 @@ This is the Python MsSpec version with support for Python 3.x and dynamic memory To work with the git repository =============================== +You can clone this repository onto your local computer using git + +```Bash +git clone https://git.ipr.univ-rennes1.fr/epsi/msspec_python3.git +``` + +This will create a folder named "msspec_python3" with all the source code inside. + It is higly recommended to work in a Python virtual environment. To create one, you can use: @@ -28,84 +36,29 @@ to activate the virtual environment (if you are in the folder where you created source ./msspec_venv/bin/activate ``` -To get the python package dependencies, you can install the requirements with the provided requirements.txt file. +Now you can build the program, go in the source folder ```Bash -pip install --upgrade -r requirements.txt +cd msspec_python3/src ``` -You also need to export the path to the msspec package in the PYTHONPATH variable (replace the whereisthegitrepo part -of the string with the actual absolute path of your repo. +Install the python package dependencies. ```Bash -export PYTHONPATH=/whereisthegitrepo/src:$PYTHONPATH +pip install -r setup_requirements.txt +pip install -r requirements.txt ``` -Finally you need to compile the fortran libs: +You need to compile the fortran libs. This is done by the scons (Software Construction) program ```Bash -make pybinding +scons ``` -That's all. All you need to do each time you want to work with msspec is: - -- To activate the virtual environment -- Export the path to msspec package in the PYTHONPATH variable - - - -To create a self-extracible archive -=================================== - -If you want to create a setup program to install msspec: - -At the root of the repo, type in +Finally, install the package in develop mode: ```Bash -make selfex +pip install -e . ``` -This will compile the code and create the results of unit tests, then it will create a self-extractible archive in the package folder - - -To install the \*.setup file -============================ - -Just execute the file with a shell - -```Bash -sh ./MsSpec-###.setup -``` - -Replace ### with the version number. - -To automatically accept the defaults you could type in - -```Bash -sh ./MsSpec-###.setup --accept -- -y -``` - -and to make the install process verbose: - -```Bash -sh ./MsSpec-###.setup -- -d -``` - - - - - - - - - - - - - - - - - - - +That's all. All you need to do each time you want to work with msspec is activating the virtual environment diff --git a/doc/source/title.svg b/doc/source/title.svg index 027ecd7..97bf931 100644 --- a/doc/source/title.svg +++ b/doc/source/title.svg @@ -211,7 +211,7 @@ MsSpec A multiple scattering package for spectroscopiesusing electrons to probe materials - post release: 11 + post release: 51