Go to file
Sylvain Tricot 927ac8a8a3 Allow the use of external potential files.
A new keyword in TMatrixParameters allows to use an external
file for the potential energy of atoms. It should be used like
this:
    calc.tmatrix_parameters.potential = 'spkkr'
    calc.tmatrix_parameters.potential_file = 'Cu.pot' # the name does not matter
2020-03-26 18:26:27 +01:00
CI Fix bugs in packaging procedure. 2020-03-12 16:16:28 +01:00
doc Fix bugs for energy scan in EIG spectroscopy. 2019-12-12 16:45:12 +01:00
src Allow the use of external potential files. 2020-03-26 18:26:27 +01:00
utils Work on continuous integration 2019-11-20 18:14:00 +01:00
.gitattributes Add .gitattributes 2019-11-15 16:53:41 +01:00
.gitignore Fix bugs for energy scan in EIG spectroscopy. 2019-12-12 16:45:12 +01:00
Jenkinsfile Fix bug in Jenkinsfile 2019-12-06 13:49:28 +01:00
Makefile Fix bugs in packaging procedure. 2020-03-12 16:16:28 +01:00
README.md Fix bug in install process. 2019-12-06 13:26:22 +01:00
SConstruct Move to SCons building tool instead of make. 2020-03-26 18:19:26 +01:00
license.txt iUpdate the license info 2019-11-15 16:24:12 +01:00

README.md

Introduction

This is the Python MsSpec version with support for Python 3.x and dynamic memory allocation for Phagen and Spec

To work with the git repository

It is higly recommended to work in a Python virtual environment. To create one, you can use:

virtualenv --python=python3 msspec_venv

or

virtualenv --python=python3 --system-site-packages msspec_venv

to activate the virtual environment (if you are in the folder where you created "msspec_venv"):

source ./msspec_venv/bin/activate

To get the python package dependencies, you can install the requirements with the provided requirements.txt file.

pip install --upgrade -r requirements.txt

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.

export PYTHONPATH=/whereisthegitrepo/src:$PYTHONPATH

Finally you need to compile the fortran libs:

make pybinding

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

make selfex

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

sh ./MsSpec-###.setup

Replace ### with the version number.

To automatically accept the defaults you could type in

sh ./MsSpec-###.setup --accept -- -y

and to make the install process verbose:

sh ./MsSpec-###.setup -- -d