MechMicroMan / DefDAP

A python library for correlating EBSD and HRDIC data
Apache License 2.0
36 stars 18 forks source link

Documentation #20

Closed merrygoat closed 5 years ago

merrygoat commented 5 years ago

I have made a few changes as we discussed last week.

I have added a docs folder with sphinx and some example documentation. You can read the documentation in the docs/html/index.html file.

I have added a setup.py to enable installation of the code as a module. The main reason to do this is to improve importing... It means you can do

from defdap import base

from anywhere on the system. This makes things like documentation and testing much easier since importing Python scripts relatively is hellish.

This does mean that you will have to install the code from the base directory with the command pip install -e .

Pull this branch and check you are happy with my changes before merging.

I will start another branch with a test template at some point this week and then we should meet again.