Commit Graph

145 Commits

Author SHA1 Message Date
Martin Diehl c40b446854 add keywords to signature of Orientation functions that inherit from Rotation 2023-02-23 18:49:08 +00:00
Philip Eisenlohr 06201da5e2 Improvements to Python docstrings 2023-02-21 15:27:06 +00:00
Philip Eisenlohr 7b8fce8db0 help polish 2022-12-05 18:29:03 -05:00
Martin Diehl c7cb56fc18 lower exponent gives smoother gradients 2022-12-02 22:55:22 +01:00
Philip Eisenlohr 6315f97f4a added explicit Optional type hint 2022-11-22 16:26:15 -05:00
Daniel Otto de Mentock 5017aabcea util.extend_docstring: proper layout for extended class (incl. current return type) 2022-11-19 08:10:00 +00:00
Martin Diehl b7cd0c1d51 increasing consistency 2022-08-10 20:51:50 +02:00
d.mentock 3492dfcd3b Adding consistency to docstring structure 2022-07-08 18:07:07 +02:00
d.mentock df1f362ed3 it's useful for users to see standard docstrings in magic methods 2022-07-08 18:06:41 +02:00
Philip Eisenlohr d10516e0b6 fixed typo 2022-06-09 17:23:16 -04:00
Philip Eisenlohr 8fefc46f38 fixed FZ conditions and tightened tolerance to accommodate higher precision "tfit" 2022-06-09 16:38:13 -04:00
Martin Diehl 90c3b3170d propagate 'normalize' option 2022-05-13 09:54:32 +02:00
Philip Eisenlohr b080e414ae normalize to_pole output by default 2022-05-11 08:55:55 -04:00
Philip Eisenlohr f13a4c82da grid.clean/vicinity now uses ball neighborhood; lots of polishing 2022-03-09 18:26:52 -05:00
Martin Diehl 03912b0a03 Merge remote-tracking branch 'origin/development' into polishing 2022-03-04 03:44:36 +01:00
Martin Diehl c7b512a94e support the user 2022-02-26 17:40:12 +01:00
Philip Eisenlohr 320ab70270 Merge branch 'development' into 'python-vtk-improvements'
# Conflicts:
#   python/damask/_vtk.py
2022-02-23 14:20:52 +00:00
Sharan Roongta f4a15f5796 Merge branch 'consistent-uppercase-in-exceptions' into 'development'
Consistent formatting of raised messages

See merge request damask/DAMASK!533
2022-02-23 13:55:14 +00:00
Philip Eisenlohr 5882a8560c shortened __repr__ code 2022-02-23 08:38:03 -05:00
Martin Diehl 77e57a268c unified.
the default python description "Return repr(self)." is pretty useless,
so better agree on a DAMASK standard
2022-02-23 07:21:30 +01:00
Philip Eisenlohr 47dcd4bd41 follow Python exception message convention of lower-case 2022-02-22 10:42:05 -05:00
Philip Eisenlohr 6a4ad7ff75 moved symmetry_operations from Orientation to Crystal 2022-02-22 10:12:03 -05:00
Philip Eisenlohr aeb0e527ec Consistent formatting of raised messages 2022-02-22 09:46:12 -05:00
Martin Diehl 35caed305f consistently define allclose for own type only 2022-02-15 22:08:12 +01:00
Martin Diehl b1922c9fc0 return most specific type 2022-02-13 11:03:53 +01:00
Martin Diehl 2907facfd3 polishing
classes should return 'MyType' for inheritance without hassle
2022-02-13 02:47:08 +01:00
Philip Eisenlohr c6a188a1fe added CrystalFamily, CrystalLattice, CrystalKinematics typehints 2022-02-11 15:41:30 -05:00
Philip Eisenlohr 0a52ae3b6f polishing of help and style; relax to FloatSequence type where appropriate but keep doc at np.ndarray 2022-02-11 14:50:55 -05:00
Daniel Otto de Mentock 8c6225794d adjusted return of Orientation.__ne__ function to return NotImplemented in case of wrong input type 2022-02-08 14:47:23 +01:00
Martin Diehl a6e83c70ec adjustments to follow de-facto standard in other parts of the python
library
2022-02-06 17:12:35 +01:00
Daniel Otto de Mentock c1c2336638 reverted __eq__ and __ne type verification to return NotImplemented constant
changed rotation.average input type to FloatSequence

minor adjustments
2022-02-04 16:57:25 +01:00
Daniel Otto de Mentock 019ae1c536 adjusted typecheck in __eq__ and __ne__ functions 2022-02-04 11:43:35 +01:00
Daniel Otto de Mentock 7a405125da added type:ignore statements to Tuple Supportsindex addition in Orientation.disorientation function 2022-02-04 10:57:24 +01:00
Daniel Otto de Mentock 9dad54304c added generic types to remaining non-overwritten rotation functions (exception __mul__) 2022-02-04 09:57:42 +01:00
Daniel Otto de Mentock d1f9e98e3c moved typecheck of __ne__ functions to __eq__
added initial empty runtimeerror to Schmid function

minor corrections
2022-02-03 16:11:09 +01:00
Daniel Otto de Mentock fc8cd6322c adjusted rng_seed type in rotation
adjusted NotImplemented error return in orientation
2022-02-02 12:16:57 +01:00
Daniel Otto de Mentock 71bc92fed0 changed quote layout to single quote Added NotImplemented returnvalue to __eq__ functions 2022-02-02 11:11:59 +01:00
Daniel Otto de Mentock cb1143a472 changed return type of util.shapeblender and util.shapeshifter from Sequence[SupportsIndex] to Tuple[SupportsIndex, ...]
ignored lines in orientation module that attempt to pass objects of type 
Tuple[SupportsIndex, ...] to np.broadcast_to()
2022-02-01 18:38:49 +01:00
Daniel Otto de Mentock 81ef865525 [skip ci] moved asterisk to seperate line 2022-01-28 10:11:34 +01:00
Daniel Otto de Mentock 0fe51f58a8 [skip ci] changed almost all function definition lines to multiline 2022-01-26 15:09:09 +01:00
Daniel Otto de Mentock 25513d572b minor type adjustment to rotation module removed superfluous Sequence type from orientation module 2022-01-14 14:55:08 +01:00
Daniel Otto de Mentock aabeee9de1 Replaced relevant Sequences with FloatSequence and IntSequence types 2022-01-14 14:37:48 +01:00
Daniel Otto de Mentock 4ba9935ccc Merge branch 'development' of git.damask.mpie.de:damask/DAMASK into typehints_orientation_rotation 2022-01-13 17:23:24 +01:00
Martin Diehl 3acabcdc7f docstring adjustments 2022-01-12 23:57:21 +01:00
Martin Diehl 19f4f2eaec nice example
too simple for full-flegded ipython notebook
2022-01-11 00:36:49 +01:00
Daniel Otto de Mentock cef885cfde added first typehints for rotation and orientation modules 2021-12-14 17:05:00 +01:00
Daniel Otto de Mentock 3b9822ad67 Revert "added first typehints for rotation and orientation modules"
This reverts commit 4235c70aea
2021-12-14 16:04:18 +00:00
Daniel Otto de Mentock 4235c70aea added first typehints for rotation and orientation modules 2021-12-14 17:01:40 +01:00
Philip Eisenlohr fbbe5ec006 fixed typo 2021-12-08 21:04:22 +00:00
Martin Diehl 509835bf0b type hints for tensor
adjustments to Rotation/Orientation needed to enable type checking with
mypy
2021-10-31 22:37:54 +01:00