Compare commits

..

9 Commits

Author SHA1 Message Date
Sylvain Tricot 9166b8d3ef Merge branch 'release/0.1.3' 2022-06-08 16:49:19 +02:00
Sylvain Tricot 549ec2ea7f Update README 2022-04-19 16:31:03 +02:00
Sylvain Tricot da10eed84e Update install instructions 2022-04-19 16:23:52 +02:00
Sylvain Tricot a073dc1520 Added INSTALL instructions. 2022-03-07 16:26:19 +01:00
Sylvain Tricot 20b7716f4a Merge tag '0.1.2' into devel
0.1.2
2022-03-07 15:40:05 +01:00
Sylvain Tricot d510806ece Merge branch 'hotfix/0.1.2' 2022-03-07 15:39:53 +01:00
Sylvain Tricot 0f2a556aa2 Fixed bug in version naming.
With git flow, the version is read by the tag
(base_version) in setuptools_scm.
2022-03-07 15:38:35 +01:00
Sylvain Tricot fc117d4e04 Merge tag '0.1.1' into devel
0.1.1
2022-03-07 15:22:55 +01:00
Sylvain Tricot d5c5073d3c Merge tag '0.1' into devel
0.1
2022-03-07 14:42:15 +01:00
3 changed files with 91 additions and 4 deletions

View File

86
README.md Normal file
View File

@ -0,0 +1,86 @@
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
```
Running the code
================
The program can be run either from the command line or from a Python script.
Command-line
------------
The executable is called 'eps'. Type in 'man eps' to get more help. It has 3 main sub-commands:
- generate
- compute
- plot
Begin by generating an input file with default values:
```
$ eps generate
```
It will create a default input file (Data/epsilon.dat).
Then, edit this input file according to your needs. You can find some details
about the allowed values of input parameters [here](./DESC) and launch a calculation.
```
$ eps compute Data/epsilon.dat
```
Finally you can plot the results
```
$ eps plot diel_func
```
Python bindings
---------------
Have a look to [this example](./examples/example00.py)

View File

@ -35,10 +35,11 @@ try:
from setuptools_scm import get_version
v = get_version(root='../../../', relative_to=__file__, version_scheme="post-release")
v = parse_version(v)
if v._version.post[-1] == 0:
__version__ = v.base_version
else:
__version__ = v.public
__version__ = v.base_version
# if v._version.post[-1] == 0:
# __version__ = v.base_version
# else:
# __version__ = v.public
except Exception as err:
try:
__version__ = get_distribution(__name__.strip('.version')).version