Merge pull request #54 from carnisj/devel

Devel

CONTRIBUTING.md

@@ -47,7 +47,7 @@ Here are a few things you can do that will increase the likelihood of your pull
 request being accepted:
 
 - Follow the [style guide][style] which is using PEP 8 recommendations.
-- Run [black] [blck] against your code.
+- Run [black] [blck] against your code, with the default line length of 88 characters.
 - Write and update tests.
 - Keep your change as focused as possible. If there are multiple changes you would 
   like to make that are not dependent upon each other, consider submitting them as 

README.rst

@@ -105,7 +105,7 @@ Changelog
 =========
 
 .. include:: ../HISTORY.rst
-  :end-before: Version 0.0.8
+  :end-before: Version 0.1.0
 
 See the full :doc:`Changelog<changelog>`
 

bcdi/postprocessing/postprocessing_utils.py

@@ -1679,7 +1679,7 @@ def ortho_modes(array_stack, nb_mode=None, method="eig", verbose=False):
      :param array_stack: the stack of modes to orthogonalize along the first dimension.
      :param nb_mode: the maximum number of modes to be returned. If None,
       all are returned. This is useful if nb_mode is used, and only a partial list
-       of modes is returned.
+      of modes is returned.
      :param method: either 'eig' to use eigenvalue decomposition or 'svd' to use
       singular value decomposition.
      :param verbose: set it to True to have more printed comments

bcdi/utils/utilities.py

@@ -711,7 +711,7 @@ def in_range(point, extent):
     :param extent: tuple of four integers (2D case) (y_start, y_stop, x_tart, x_stop)
      or six integers (3D case)
      (z_start, z_stop, y_start, y_stop, x_tart, x_stop) representing the range of
-      valid indices
+     valid indices
     :return: True if point belongs to extent, False otherwise
     """
     # check parameters
@@ -773,8 +773,8 @@ def linecut(array, point, direction, direction_basis="voxel", voxel_size=1):
     :param direction_basis: 'orthonormal' if the vector direction is expressed in
      an orthonormal basis. In that case it
      will be corrected for the different voxel sizes in each direction. 'voxel' if
-      direction is expressed in the non-orthonormal basis defined by the voxel sizes
-      in each direction.
+     direction is expressed in the non-orthonormal basis defined by the voxel sizes
+     in each direction.
     :param voxel_size: real positive number or tuple of 2 (for 2D) or 3 (for 3D)
      real positive numbers representing the voxel size in each dimension.
     :return: distances (1D array, distance along the linecut in the unit given by
@@ -1635,7 +1635,7 @@ def rotate_vector(
      reference_axis will be discarded.
     :return: tuple of three ndarrays in CXI convention z y x, each of shape
      (vectors[0].size, vectors[1].size, vectors[2].size). If a single vector is
-      provided, returns a 1D array of size 3.
+     provided, returns a 1D array of size 3.
     """
     # check parameters
     if isinstance(vectors, np.ndarray):

doc/conf.py

@@ -54,9 +54,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = "0.1.1"
+version = "0.1.2"
 # The full version, including alpha/beta/rc tags.
-release = "0.1.1"
+release = "0.1.2"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.py

@@ -19,7 +19,7 @@
 
 setup(
     name="bcdi",
-    version="0.1.1",
+    version="0.1.2",
     packages=find_packages(),
     include_package_data=True,
     # package_data={'bcdi/preprocessing': ['bcdi/preprocessing/alias_dict.txt']},