Trevor Irons 6 years ago
parent
commit
4cf891d084
3 changed files with 35 additions and 0 deletions
  1. 2
    0
      INSTALL.txt
  2. 32
    0
      README.md
  3. 1
    0
      _config.yml

+ 2
- 0
INSTALL.txt View File

@@ -1,3 +1,5 @@
1
+Thank you for your interest in Akvo! 
2
+
1 3
 Akvo is a surface NMR (sNMR) processing utility. Currently preprocessing is supported, but we are adding inversion capabilities. Let us know if you are looking for something. 
2 4
 
3 5
 Installation is done in the typical python fashion

+ 32
- 0
README.md View File

@@ -0,0 +1,32 @@
1
+# Akvo 
2
+ 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.
3
+
4
+The bleeding-edge code may be accesed using the git client 
5
+```
6
+git clone https://git.lemmasoftware.org/akvo.git  
7
+```
8
+or, using our GitHub mirror 
9
+```
10
+git clone https://github.com/LemmaSoftware/akvo.git  
11
+```
12
+
13
+## Installation 
14
+Installation is straightforward. The only prerequisite that is sometimes not properly handled is PyQt5 which needs to be manually installed. 
15
+
16
+```
17
+python3 setup.py build 
18
+python3 setup.py install
19
+```
20
+
21
+## Team 
22
+Akvo is developed by several teams including the University of Utah.
23
+
24
+## Capabilities 
25
+Akvo currently has preprocessing capabilities for VistaClara GMR data. 
26
+
27
+## Benefits 
28
+Processing steps are retained and logged in the processed file header, which is written in YAML. 
29
+This allows data processing to be repeatible, which is a major benefit. 
30
+
31
+## Languages
32
+Akvo is written primarily in Python 3, but has components written in R as well. The graphical user unterface is written in PyQt5.  An interface to modelling software written in C++ is in development. 

+ 1
- 0
_config.yml View File

@@ -0,0 +1 @@
1
+theme: jekyll-theme-leap-day

Loading…
Cancel
Save