Merge pull request #90 from deepanshs/djs/release_3_1

v3.1: doc and version update

Author: deepanshs

CHANGELOG

@@ -1,14 +1,19 @@
 v0.3.1
+------
+
+What's new!
+'''''''''''
 
 - Simplified plot_3d function
+- Replace fortran code with numba jit python version.
 
 v0.3.0
 ------
 
 What's new!
 '''''''''''
 
-- Added T1, T2 relaxation inversion kerenel.
+- Added T1, T2 relaxation inversion kernel.
 
 v0.2.0
 ------

mrinversion/__init__.py

@@ -1 +1 @@
-__version__ = "0.3.1.dev1"
+__version__ = "0.3.1"

mrinversion/kernel/__init__.py

@@ -1,2 +1,3 @@
+"""Initialization of the kernel module."""
 from mrinversion.kernel.relaxation import T1  # NOQA
 from mrinversion.kernel.relaxation import T2  # NOQA

mrinversion/kernel/base.py

@@ -1,3 +1,4 @@
+"""Base classes for kernel generation."""
 from copy import deepcopy
 
 import csdmpy as cp

mrinversion/tests/fista_intergration_test.py

@@ -1,3 +1,4 @@
+"""Integration tests for FISTA implementation."""
 import csdmpy as cp
 import numpy as np
 

setup.cfg

@@ -16,3 +16,4 @@ addopts =
 omit =
     setup.py
     mrinversion/utils.py
+    mrinversion/linear_model/fista/__init__.py

setup.py

@@ -1,10 +1,11 @@
+"""Setup for mrinversion package."""
 from os.path import abspath
 from os.path import dirname
 from os.path import join
 from setuptools import find_packages, setup
 
 
-with open("mrinversion/__init__.py") as f:
+with open("mrinversion/__init__.py", encoding="utf-8") as f:
     for line in f.readlines():
         if "__version__" in line:
             before_keyword, keyword, after_keyword = line.partition("=")
@@ -32,7 +33,7 @@
         "Python based statistical learning of NMR tensor and relaxation parameters "
         "distribution."
     ),
-    long_description=open(join(module_dir, "README.md")).read(),
+    long_description=open(join(module_dir, "README.md"), encoding="utf-8").read(),
     long_description_content_type="text/markdown",
     author="Deepansh J. Srivastava",
     author_email="deepansh2012@gmail.com",