Bladeren bron

1.0.14

tags/1.6.1
Trevor Irons 5 jaren geleden
bovenliggende
commit
da8b7fbaae
2 gewijzigde bestanden met toevoegingen van 22 en 15 verwijderingen
  1. 21
    14
      README.md
  2. 1
    1
      setup.py

+ 21
- 14
README.md Bestand weergeven

@@ -1,8 +1,8 @@
1
-# Akvo 
2
-
1
+Akvo 
2
+====
3 3
 Akvo provides processing of surface NMR data. It aims to be simple to use yet flexible for accommodating changes to processing flow. Akvo is written primarily in Python 3 with a small amount of R as well. The application is written around a Qt GUI with plotting provided by Matplotlib.
4 4
 
5
-The bleeding-edge code may be accesed using the git client 
5
+The bleeding-edge code may be accessed using the git client 
6 6
 ```
7 7
 git clone https://git.lemmasoftware.org/akvo.git  
8 8
 ```
@@ -11,7 +11,8 @@ or, using our GitHub mirror
11 11
 git clone https://github.com/LemmaSoftware/akvo.git  
12 12
 ```
13 13
 
14
-## Installation 
14
+Installation 
15
+============
15 16
 
16 17
 Installation is straightforward. The only prerequisite that is sometimes not properly handled is PyQt5 which sometimes needs to be manually installed. 
17 18
 ```
@@ -24,20 +25,26 @@ Alternatively, release versions can be installed via pip
24 25
 pip install akvo
25 26
 ```
26 27
 
28
+Team 
29
+====
30
+Akvo is developed by several teams including the University of Utah. If you would like to contribute, please send an email to info(at)lemmasoftware.org. 
27 31
 
28
-## Team 
29
-
30
-Akvo is developed by several teams including the University of Utah.
31
-
32
-## Capabilities 
33
-
32
+Capabilities 
33
+============
34 34
 Akvo currently has preprocessing capabilities for VistaClara GMR data. 
35 35
 
36
-## Benefits 
36
+Benefits 
37
+========
37 38
 
39
+Reproducibility
40
+---------------
38 41
 Processing steps are retained and logged in the processed file header, which is written in YAML. 
39
-This allows data processing to be repeatible, which is a major benefit. 
42
+This allows data processing to be repeatable. 
40 43
 
41
-## Languages
44
+Open source
45
+----------
46
+Akvo is truly open source, anyone can access, use, and change the source code. 
42 47
 
43
-Akvo is written primarily in Python 3. The graphical user unterface is written in PyQt5.  An interface to modelling software written in C++ (Lemma and Merlin) is in development. 
48
+Languages
49
+=========
50
+Akvo is written primarily in Python 3. The graphical user interface is written in PyQt5.  An interface to modelling software written in C++ (Lemma and Merlin) is in development. 

+ 1
- 1
setup.py Bestand weergeven

@@ -21,7 +21,7 @@ with open("README.md", "r") as fh:
21 21
     long_description = fh.read()
22 22
 
23 23
 setup(name='Akvo',
24
-      version='1.0.13',
24
+      version='1.0.14',
25 25
       description='Surface nuclear magnetic resonance workbench',
26 26
       long_description=long_description,
27 27
       author='Trevor P. Irons',

Laden…
Annuleren
Opslaan