Metadata-Version: 2.3
Name: ExMechEva
Version: 0.1.2
Summary: Evaluation of experimental mechanics data
Project-URL: Homepage, https://github.com/MarcGebhardt/ExMechEva
Project-URL: Issues, https://github.com/MarcGebhardt/ExMechEva/issues
Project-URL: Source, https://github.com/MarcGebhardt/ExMechEva
Project-URL: Changelog, https://github.com/MarcGebhardt/ExMechEva/CHANGELOG.md
Author-email: Marc Gebhardt <marcgebhardt.dev+gheme@gmail.com>
Maintainer-email: Marc Gebhardt <marcgebhardt.dev+gheme@gmail.com>
License: MIT License
                
                Copyright (c) 2023 MarcGebhardt
                
                Permission is hereby granted, free of charge, to any person obtaining a copy
                of this software and associated documentation files (the "Software"), to deal
                in the Software without restriction, including without limitation the rights
                to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
                copies of the Software, and to permit persons to whom the Software is
                furnished to do so, subject to the following conditions:
                
                The above copyright notice and this permission notice shall be included in all
                copies or substantial portions of the Software.
                
                THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
                IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
                FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
                AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
                LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
                OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
                SOFTWARE.
License-File: LICENSE
Keywords: axial compression,axial tension,biomechanics,experimental mechanics,three point bending
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.7.10
Requires-Dist: lmfit>=1.0.2
Requires-Dist: matplotlib>=3.3.4
Requires-Dist: numpy>=1.20.3
Requires-Dist: pandas>=1.3.0
Requires-Dist: scikit-posthocs>=0.7.0
Requires-Dist: scipy>=1.6.2
Requires-Dist: seaborn>=0.11.1
Requires-Dist: statsmodels>=0.12.2
Requires-Dist: sympy>=1.8
Requires-Dist: tqdm>=4.61.2
Requires-Dist: vg>=1.9.0
Description-Content-Type: text/markdown

# ExMechEva - Experimental mechanics evaluation

Evaluation of data determined by means of experimental mechanics.
Automation and standardization, considering special requirements of project and test specimen.

## Installation
`ExMechEva` is developed under Python 3.7.10 and is available in the [Python Package Index (PyPI)](https://pypi.org/project/ExMechEva/).

To install the latest stable version, please run:  
- Linux and Mac: `python3 -m pip install -U ExMechEva`
- Windows: `py -m pip install -U ExMechEva`   

To install the development version:  
- download/clone [Github](https://github.com/MarcGebhardt/ExMechEva)
- install requirements
- make the modules available by adding the `ExMechEva` directory to the `$PYTHONPATH` system variable or inside python with:  
```
import sys
sys.path.insert(-1,'Path\To\Project\ExMechEva')
```

## Getting started
In [EXAMPLES](./scripts/00_examples) you can find example scripts evaluating test data provided in [DATA](./data/test).
Available are:
- Simple axial compression test [ACT](./scripts/00_examples/ACT_Test.py) evaluating [ACT-DATA](./data/Test/ACT/Series_Test/)
- Cyclic preloaded axial tensile test [ATT](./scripts/00_examples/ATT_Test.py) evaluating [ATT-DATA](./data/Test/ATT/Series_Test/)
- Three-point bending test [TBT](./scripts/00_examples/TBT_Test.py), with different elastic modulus evalutaion types, evaluating [TBT-DATA](./data/Test/TBT/Series_Test/)

To start, select evaluation option (by uncommenting):
- 'single': Evaluate single measurement
- 'series': Evaluate series of measurements
- 'complete': Evaluate series of series
- 'pack': Pack all evaluations into single hdf-file (only results and evaluated measurement)
- 'pack-all': Pack all evaluations into single hdf-file with (all results, Warning: high memory requirements!)

## Contributing
See [CONTRIBUTING](./CONTRIBUTING.md) for details on how to contribute to `exmecheva`.
Please observe the [CODE OF CONDUCT](./CODE_OF_CONDUCT.md).
Overview of news is given in [CHANGELOG](./CHANGELOG.md).

## Development targets and ToDos
It is planned to extend the use of this package and make it as easily available as possible for scientific purposes.
Some important points should therefore be taken into account, which are for example:
- Improvement of documentation
- Implementation of test routines in [TESTS](./tests/)
- [PEP8](https://peps.python.org/pep-0008/) styleguide adaptations
- Updating of environment (now python 3.7.10)
- Development of a generally customizable routine that can be controlled with keywords. 
  (please see curve_characterizer and following in [Measurement Curve Characteriszation](./exmecheva/common/mc_char.py))
- Implementing of physical units ([pint](https://github.com/hgrecco/pint)/[pint-pandas](https://github.com/hgrecco/pint-pandas))
- GUI development for easy, reliable and reproducable use
- Implementing of option for input definition (p.e. positve direction of displacment measurement)
- Expandability to personal usage scenarios

## Citation
If you use this framework, please cite this paper:
```
@article{GebhardtKurz_2024_ASCTE,
  author          = {Marc Gebhardt, Sascha Kurz, Fanny Grundmann, Thomas Klink, Volker Slowik, Christoph-Eckhard Heyde, Hanno Steinke},
  date            = {planned 2024},
  journaltitle    = {Plos One},
  title           = {Approach to standardized material characterization of the human lumbopelvic system – testing and evaluation},
  doi             = {...},
  issn            = {1932-6203},
  language        = {english},
}
```
## Licence and Copyright
**Author:** Marc Gebhardt.  
**Copyright:** Copyright by the authors, 2023.  
**License:** This software is released under MIT licence, see [LICENSE](./LICENSE) for details.