Small styling fixes. Add LICENSE.md.

otvam · Jan 24, 2023 · 274d000 · 274d000
1 parent ea2fb8a
commit 274d000
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 6 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,12 @@
+(c) 2023 - Thomas Guillod - Dartmouth College
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDi
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/PyPEEC/lib_mesher/stl_mesher.py b/PyPEEC/lib_mesher/stl_mesher.py
@@ -42,7 +42,7 @@ def _get_grid(n, d, c):
 
 def get_voxelize(grid, mesh):
     """
-    Voxelixe a STL mesh with respect to an uniform grid.
+    Voxelixe a STL mesh with respect to a uniform grid.
     Return the indices of the created voxels.
     """
 

diff --git a/PyPEEC/lib_mesher/voxel_summary.py b/PyPEEC/lib_mesher/voxel_summary.py
@@ -24,7 +24,7 @@ def get_status(n, d, c, domain_def, connection_def):
     # compute
     n_total = nx*ny*nz
     n_graph = len(connection_def)
-    n_domain =  len(domain_def)
+    n_domain = len(domain_def)
 
     # get the used voxels
     n_used = 0

diff --git a/PyPEEC/lib_visualization/manage_voxel.py b/PyPEEC/lib_visualization/manage_voxel.py
@@ -50,7 +50,7 @@ def _get_graph_component(idx, connection_def):
 
     # find to corresponding connected components
     for i, idx_graph in enumerate(connection_def):
-        # find which indices are belong to this connected component
+        # find which indices are part of the connected component
         idx_ok = np.in1d(idx, idx_graph)
 
         # assign the component number to the corresponding indices
@@ -151,7 +151,7 @@ def get_viewer_domain(domain_def, connection_def):
         # assign the color (n different integer for each domain)
         (dom_tmp, counter) = _get_domain_tag(idx_tmp, counter)
 
-        # compute to which connected component the indices are belonging
+        # find the connected components corresponding to the indices
         gra_tmp = _get_graph_component(idx_tmp, connection_def)
 
         # append the indices and colors

diff --git a/setup.cfg b/setup.cfg
@@ -10,9 +10,9 @@ license = (c) 2023 - Thomas Guillod - Dartmouth College
 author = Thomas Guillod
 author_email = [email protected]
 url = https://github.com/otvam/PyPEEC
-long_description = file: README.md
+long_description = file: README.md, LICENSE.md
 long_description_content_type = text/markdown
-keywords = pyPEEC, FFT, PEEC, magnetic, frequency domain, voxel, 3D
+keywords = PyPEEC, FFT, PEEC, magnetic, frequency domain, voxel, 3D
 classifiers =
     Development Status :: 4 - Beta
     Environment :: Console