PY: Update version, update release notes.

Signed-off-by: Michael Jackson <[email protected]>
BlueQuartzSoftware · Oct 29, 2023 · 487d08e · 487d08e
1 parent 7d13d2f
commit 487d08e
Show file tree

Hide file tree

Showing 11 changed files with 142 additions and 40 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -63,7 +63,7 @@ option(COMPLEX_ENABLE_INSTALL "Enables COMPLEX install rules" ON)
 file(TO_CMAKE_PATH "${CMAKE_COMMAND}" CMAKE_COMMAND_NORM)
 
 project(complex
-  VERSION 0.1.0
+  VERSION 1.1.0
   DESCRIPTION "SIMPL Redesign"
   HOMEPAGE_URL "https://github.com/BlueQuartzSoftware/complex"
   LANGUAGES CXX

diff --git a/conda/meta.yaml b/conda/meta.yaml
@@ -1,5 +1,5 @@
 {% set name = "complex" %}
-{% set version = "1.0.0" %}
+{% set version = "1.1.0" %}
 
 package:
   name: {{ name|lower }}
@@ -9,7 +9,7 @@ source:
   - path: ../
     folder: complex
   - git_url: https://github.com/BlueQuartzSoftware/EbsdLib
-    git_rev: v1.0.25
+    git_rev: v1.0.26
     folder: EbsdLib
   - git_url: https://github.com/BlueQuartzSoftware/H5Support
     git_rev: v1.0.13

diff --git a/conda/recipe.yaml b/conda/recipe.yaml
@@ -1,5 +1,5 @@
 context:
-  version: "1.0.0"
+  version: "1.1.0"
   name: complex
 
 package:
@@ -10,7 +10,7 @@ source:
   - path: ../
     folder: complex
   - git_url: https://github.com/BlueQuartzSoftware/EbsdLib
-    git_rev: v1.0.25
+    git_rev: v1.0.26
     folder: EbsdLib
   - git_url: https://github.com/BlueQuartzSoftware/H5Support
     git_rev: v1.0.13

diff --git a/wrapping/python/ReadMe.md b/wrapping/python/ReadMe.md
@@ -1,6 +1,5 @@
 # Complex Python Information
 
-
 ## Creating the Python Bindings
 
 ### MacOS: Use Mamba
@@ -15,45 +14,54 @@ I elected to install into `/opt/local/mambaforge`
 
 once you get that installed do:
 
+```shell
+    [user@host] $ /opt/local/mambaforge/bin/mamba init
 ```
-/opt/local/mambaforge/bin/mamba init
-```
+
 which will edit your .zshrc file.
 
 RELAUNCH A NEW TERMINAL!!!!
 
-```
-mamba create -n nx-build python=3.8
-mamba activate nx-build
-mamba install boa
+```shell
+    [user@host] $ mamba create -n nx-build python=3.10
+    [user@host] $ mamba activate nx-build
+    [user@host] $ mamba install boa
 ```
 
 Create the package from the `complex` sources
 
+```shell
     [user@host] $ cd complex/conda
-    [user@host] $ boa build .
+    (nx-build) [user@host] $ conda mambabuild --python 3.8 .; conda mambabuild --python 3.9 .; conda mambabuild --python 3.10 . 
 
-### Windows/Linux:
+```
+
+### Windows/Linux
 
+```shell
     [user@host] $ cd complex/conda
     [user@host] $ conda build . 
+```
 
-For faster environment solves mamba can also be used. 
+For faster environment solves mamba can also be used.
 
-```
+```shell
 conda install boa
 conda mambabuild --python 3.8|3.9|3.10 .
 ```
 
 ### Uploading to Anaconda.org
 
-    [user@host] $ conda login
-    [user@host] $ conda upload -c bluequartzsoftware [path/to/tar.bz]
+Open a "base" anaconda prompt.
 
-## Using the Python Bindings
+```shell
+    [user@host] $ anaconda login
+    [user@host] $ anaconda upload -c bluequartzsoftware [path/to/tar.bz]
+```
 
+## Using the Python Bindings
 
-```
+```shell
 conda config --add channels conda-forge
 conda config --set channel_priority strict
 conda create -n cxpython python=3.8
@@ -62,4 +70,3 @@ conda install -c bluequartzsoftware complex
 ```
 
 If you plan to use jupyter notebooks, then any other kernels and such will also need to be installed. VS Code does this for you.
-
diff --git a/wrapping/python/docs/ReadMe.md b/wrapping/python/docs/ReadMe.md
@@ -1,7 +1,7 @@
 # Creating Python Documentation with Sphinx
 
 ``` shell
-conda create -n d3ddocs python=3.8 sphinx myst-parser sphinx-markdown-tables sphinx_rtd_theme
+conda create -n d3ddocs python=3.10 sphinx myst-parser sphinx-markdown-tables sphinx_rtd_theme
 conda activate d3ddocs
 cd complex/docs/
 make html

diff --git a/wrapping/python/docs/index_template.rst b/wrapping/python/docs/index_template.rst
@@ -3,7 +3,10 @@
    generated, you will need to add those to the list below
 
 DREAM3D-NX Python Docs
-================================
+=======================
+
+Latest Version: 1.1.0
+---------------------
 
 The *complex* library can be installed through an Anaconda packages from the *BlueQuartzSoftware* channel. This can be achieved
 by creating a new virtual environment
@@ -12,7 +15,7 @@ by creating a new virtual environment
 
     conda config --add channels conda-forge
     conda config --set channel_priority strict
-    conda create -n cxpython python=3.9
+    conda create -n cxpython python=3.10
     conda activate cxpython
     conda install -c bluequartzsoftware complex
 
@@ -21,6 +24,7 @@ by creating a new virtual environment
    :caption: Contents:
 
    Installation
+   ReleaseNotes
    Overview
    DataObjects
    Geometry

diff --git a/wrapping/python/docs/source/API.rst b/wrapping/python/docs/source/API.rst
@@ -193,17 +193,17 @@ General Parameters
 
    .. code:: python
 
-    cx.DataType.boolean
-    cx.DataType.uint8
-    cx.DataType.int8
-    cx.DataType.uint16
-    cx.DataType.int16
-    cx.DataType.uint32
-    cx.DataType.int32
-    cx.DataType.uint64
-    cx.DataType.int64
-    cx.DataType.float32
-    cx.DataType.float64
+      cx.DataType.int8
+      cx.DataType.uint8
+      cx.DataType.int16
+      cx.DataType.uint16
+      cx.DataType.int32
+      cx.DataType.uint32
+      cx.DataType.int64
+      cx.DataType.uint64
+      cx.DataType.float32
+      cx.DataType.float64
+      cx.DataType.boolean
 
 .. _Dream3dImportParameter:
 .. py:class:: Dream3dImportParameter
@@ -405,14 +405,14 @@ General Parameters
       correctly.
 
    :ivar input_file_path: "PathLike".  The path to the input file on the file system.
-   :ivar start_import_row: Int.  What line number does the data start on. 1 Based numbering scheme.
+   :ivar start_import_row: Int.  What line number does the data start on. ONE (1) Based numbering scheme.
    :ivar delimiters: List[string]. List of delimiters that will be used to separate the lines of the file into columns.
    :ivar consecutive_delimiters: Bool. Should consecutive delimiters be counted as a single delimiter.
    :ivar custom_headers: List[string]. If the file does not have headers, this is a list of string values, 1 per column of data, that will also become the names of the created  :ref:`DataArray<DataArray>`.
-   :ivar data_types: List[cx.DataType]. The DataType, one per column, that indicates the kind of native numerical values (int, float... ) that will be used in the created  :ref:`DataArray<DataArray>`.
+   :ivar data_types: List[:ref:`cx.DataType<DataTypeParameter>`]. The DataType, one per column, that indicates the kind of native numerical values (int, float... ) that will be used in the created  :ref:`DataArray<DataArray>`.
    :ivar skipped_array_mask: List[bool]. Booleans, one per column, that indicate whether or not to skip importing each created :ref:`DataArray <DataArray>`.
    :ivar tuple_dims: List[int]. The tuple dimensions for the created  :ref:`DataArrays <DataArray>`.
-   :ivar headers_line: Int. The line number of the headers.
+   :ivar headers_line: Int. The line number of the file that has the headers listed on a single line. ONE (1) based indexing.
    :ivar header_mode: 'cx.ReadCSVData.HeaderMode.'. Can be one of 'cx.ReadCSVData.HeaderMode.Line' or 'cx.ReadCSVData.HeaderMode.Custom'.
 
 

diff --git a/wrapping/python/docs/source/DataObjects.rst b/wrapping/python/docs/source/DataObjects.rst
@@ -43,6 +43,7 @@ called *Euler Angles* within that group the **DataPath** object that would be co
 .. code:: python
 
   array_path = cx.DataPath(['MyGroup', 'Euler Angles'])
+  array_path = cx.DataPath("MyGroup/Euler Angles")
 
 
 .. _DataGroup:

diff --git a/wrapping/python/docs/source/Installation.rst b/wrapping/python/docs/source/Installation.rst
@@ -1,14 +1,17 @@
 Installation
 ============
 
+Latest Version: 1.1.0
+---------------------
+
 The *complex* library can be installed through an Anaconda packages from the *BlueQuartzSoftware* channel. This can be achieved
 by creating a new virtual environment
 
 .. code:: shell
 
     conda config --add channels conda-forge
     conda config --set channel_priority strict
-    conda create -n cxpython python=3.8
+    conda create -n cxpython python=3.10
     conda activate cxpython
     conda install -c bluequartzsoftware complex
 
diff --git a/wrapping/python/docs/source/ReleaseNotes.rst b/wrapping/python/docs/source/ReleaseNotes.rst
@@ -0,0 +1,87 @@
+Release Notes
+=============
+
+The `complex` library is under activate development and while we strive to maintain a stable API bugs are
+found the necessitate the changing of the API.
+
+Version 1.1.0
+-------------
+
+API Additions
+^^^^^^^^^^^^^
+
+- DataPath: A :ref:`DataPath<DataPath>` object can now be constructed with a "/" separated string in addition to a list of strings.
+
+  .. code:: python
+
+    some_path = complex.DataPath("DataContainer/AttributeMatrix/DataArray")
+
+
+Filter Changes
+^^^^^^^^^^^^^^
+
+- Filters that used a "Mask Array" or a "Good Voxels" array have all been changed to use following terms:
+
+   - OLD: 'use_good_voxels' **NEW:** 'use_mask'
+   - OLD: 'good_voxels_array_path'  **NEW:** 'mask_array_path'
+   - REASONING: This presents a consistent API to the developer across all filters
+
+- ImportCSVDataFilter:
+
+    This filter has been changed to "ReadCSVFilter". The input parameter has also changed. See the :ref:`ReadCSVFileParameter<ReadCSVFileParameter>` for more information.
+
+
+Git Log
+^^^^^^^
+
+- BUG: Export ASCII Data now exports multiple arrays correctly. (#756) - [2023-10-27]
+- ENH: Use "Mask" instead of "GoodVoxels" consistently for human facing strings. (#755) - [2023-10-27]
+- PY: Use SPHINX_BUILD_EXECUTABLE instead of SPHINX_EXECUTABLE (#750) - [2023-10-26]
+- ENH: Additions to nxrunner for detailed version information. (#752) - [2023-10-26]
+- ENH: Add HumanStringToDataType Method in TypesUtilities.h (#754) - [2023-10-26]
+- ENH: Create DataModifiedAction that marks DataObjects as being modified by a filter (#735) - [2023-10-25]
+- ENH: Added 4 Major Issue Templates (#749) - [2023-10-25]
+- API: Added cx.DataPath constructor to take a "/Path/Like/This" string (#751) - [2023-10-24]
+- ENH: Standardize and Cache Random Seed values used in filters  (#745) - [2023-10-24]
+- ENH: GenerateColorTable allows use of a mask array. (#747) - [2023-10-20]
+- ENH: Convert AttributeArray DataType allows user to delete input array. (#746) - [2023-10-19]
+- TEST: Add Unit test for empty Help Strings in filters. Clean up empty help strings (#744) - [2023-10-18]
+- DOC: Add Yang Liu as a Contributor for Research and Data (#743) - [2023-10-17]
+- DOC: Improve explanations for the Find Average C-Axis algorithm. (#741) - [2023-10-17]
+- FILTER: EDAX .ang file Hex Grid To Sqaure Grid Converter (#738) - [2023-10-17]
+- ENH: Replaced CMAKE_CFG_INTDIR with $<CONFIG> (#687) - [2023-10-15]
+- DOC: Update documentation files to allow Sphinx to generate html documentation (#708) - [2023-10-12]
+- BUG: Normalize Final Find Avg C Axes Direction Vector (#739) - [2023-10-12]
+- ENH: Read CSV File Filter Redesign (#706) - [2023-10-12]
+- DOCS: Update to the python docs. (#733) - [2023-10-09]
+- ENH: Add proper sample and crystal reference frame rotations to these pipelines (#734) - [2023-10-09]
+- REQ: Update EbsdLib Requirement to v1.0.26 (#711) - [2023-10-06]
+- DOC: Small documentation fixes. (#732) - [2023-10-06]
+- DOC: Add VKUDRI as a Contributor for Code (#727) - [2023-10-05]
+- DOC: Add john-stone-ics as a Contributor for Code (#726) - [2023-10-05]
+- DOC: Add bpenniebq as a Contributor for Code (#725) - [2023-10-05]
+- Docs: Add nyoungbq as a Contributor for Code (#724) - [2023-10-05]
+- DOC: Add mmarineBlueQuartz as a Contributor for Code (#723) - [2023-10-05]
+- DOC: Add jmarquisbq as a Contributor for Code (#722) - [2023-10-05]
+- DOC: Add joeykleingers as a Contributor for Code (#721) - [2023-10-05]
+- DOC: Add JDuffeyBQ as a Contributor for Code (#720) - [2023-10-05]
+- Docs: Add imikejackson as a Contributor for Code (#718) - [2023-10-05]
+- BUG: Update .all-contributorsrc (#713) - [2023-10-05]
+- DOC/ENH: Contributor Updates (#712) - [2023-10-05]
+- COMP: Fix compiler warnings due to casting. (#709) - [2023-10-04]
+- ENH: Remove dependency on EbsdLib for the Parameter. (#702) - [2023-10-03]
+- DOC: Fill in missing ITK Filter help text. Improves generated python documentation (#707) - [2023-10-02]
+- BUG: ITK Filters should check total number of tuples for input compatibility (#705) - [2023-09-29]
+- BUG: STLFileReader/Writer - Fix crash when reading certain kinds of STL Files. Fix output path when writing (#701) - [2023-09-26]
+- BUG/PERF: Find Neighborhoods Progress and Parallel Optimizations (#697) - [2023-09-21]
+- BUG: Fix human name for FeatureFaceCurvatureFilter (#695) - [2023-09-20]
+- BUG: Disable parallel for Find Neighborhoods and Fix Copy Error In Fill Bad Data (#694) - [2023-09-20]
+- CONDA: Various fixes to allow packaging of python bindings. (#691) - [2023-09-18]
+- ENH: Add More Resampling Modes To Resample Image Geometry (#689) - [2023-09-13]
+- Filter: SurfaceNets Surface Meshing Implementation (#619) - [2023-09-13]
+- ENH: Improve the Tuple Count validation error reporting (#684) - [2023-09-12]
+- ENH: Python binding documentation and autogeneration (#673) - [2023-09-12]
+- TEST: Update PartitionGeometry Unit test to use Catch2 GENERATOR sections (#666) - [2023-09-02]
+- ENH: Calculate "Modal Histogram Bin Ranges" Array In Find Attribute Array Statistics (#686) - [2023-09-02]
+- ENH: Changed STLFileReader filter to allow user setting of FaceNormals. (#680) - [2023-09-02]
+- FILTER: Import Fiji Montage (#667) - [2023-09-01]
diff --git a/wrapping/python/docs/source/conf.py b/wrapping/python/docs/source/conf.py
@@ -9,7 +9,7 @@
 project = 'DREAM3D-NX'
 copyright = '2023, BlueQuartz Software, LLC'
 author = 'BlueQuartz Software, LLC'
-release = '1.0.0'
+release = '1.1.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration