Metadata-Version: 2.1
Name: pynamix
Version: 0.3.2
Summary: Tools for dealing with radiographs produced in DynamiX
Home-page: http://github.sydney.edu.au/scigem/pynamix
Author: Benjy Marks, François Guillard
Author-email: benjy.marks@sydney.edu.au
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# PynamiX

[Documentation here](https://scigem.github.io/PynamiX/build/html/index.html), or compile it yourself following the details below).

## Installation
Work in progress. Hopefully via `pip install pynamix` but YMMV. If installing from github, try cloning and then running:
```
python3 setup.py build
python3 setup.py install
```
If you make any changes to the source code, re-run those two lines to have your changes reflected in your installed package.

## Examples
Try out the included Jupyter notebook to see how to use the package.

## Dependencies
Should be handled in pip install for you. Currently requires:
- python3
- matplotlib
- numpy
- scipy
- imageio

## Documentation

We use `sphinx` to manage the docs. Update documentation with:
```
cd docs
make html
```
Once these are built, you can commit and push the changes to github to have them refreshed on github pages. You can also view them locally.

## Roadmap

A sorted implementation list is as follows:

    1. Size measurement using the FFT technique
    2. Option to choose between FFT and wavelet transform for size measurement
    3. Wrapper for James's PIV code
    4. Wrapper for James's fake radiograph generator

## Deploying to PyPI (just a reminder for Benjy, please don't try this yourself)
Run the following to make a new distribution and upload it to PyPI. **Note**: You first need to update the version number in `setup.py`.
```
python3 setup.py sdist
twine upload dist/*
```

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
