Metadata-Version: 2.1
Name: npp-materialslab-tools
Version: 0.0.9
Summary: A package for the material lab tools
Home-page: 
Author: N. Papadakis
Author-email: npapnet@gmail.com
Project-URL: Documentation, https://npapnet.github.io/hmu.materialslab.tools/
Project-URL: Source, https://github.com/npapnet/hmu.materialslab.tools
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# npp_materialslab_tools

Author: Nikolaos Papadakis

This is a repository for the materials lab at HMU.

documentation is in the github pages for [hmu.materialslab.tools](https://npapnet.github.io/hmu.materialslab.tools/).

It contains a number of utilities for the easier (and verified) calcualation of properties from the tests that are normally carried out. 

It contains:
- Tensile testing with the Imada MX2 universal testing machine
  - a quick utility based on a matplotlib window
  - a tk mvc controller window with more capabilities
- DIC processing for tensile testing.
  - batch processing
  - rolling gui (incomplete)
  - types of strain:
    - true strain
    - engineering strain (cauchy)
  - interpolation:
    - linear
    - cubic
    - spline
    - raw
  - output images
    - displacement
    - markers
    - grid
    - strain map (not complete)
- capture gui for a microscope USB camera
- Tektronix dmm 4020 Digital multimeter function
  - for logging data (simple script)
  - for logging data (tk mvc controller window)


# installation

cd to the directory and execute

> python setup.py install
> python setup.py develop

or (when loaded to pypi)

> pip install npp_materialslab_tools

to use it import:

> import npp_materialslab_tools as mlt

#  Installation procedure using Conda

## creating a new environment (recommended)

This is the recommended method.

```bash
> conda create -n materialslab python=3
> conda activate materialslab 

```

Alternatively *if you are running low on space on a SSD * drive you can use the prefix option (**IMPORTANT:** read through the following [StackOverflow Question: how to specify new environment location for conda create](https://stackoverflow.com/questions/37926940/how-to-specify-new-environment-location-for-conda-create))


## Install dependencies

Activate the new conda environment and install the following:

```bash
> conda activate materialslab
> conda install opencv numpy scipy
> conda install matplotlib  pandas seaborn
> conda install ipython jupyter
> conda install openpyxl
```


## Install materialslab package.

### from source

Clone the repository from online to <hmu.materialslab.tools>.

Change directory into **<hmu.materialslab.tools>/pypkg/**

> cd ./pypkg

Install the package locally:

> python setup.py install

### from pypi (not yet implemented)

This will be simpler but not yet implemented

```bash
> pip install materialslab-whatevername
```
