README.txt

#################################################################
Things needed to install:
matplotlib: install using python3 -m pip install -U matplotlib
scipy: pip3 install --user scipy
cython
python-tk: on Linux- sudo apt-get install python3-tk
pyffi: pip3 install --user pyffi

#################################################################
To run- you must use Python3 (ideally Python 3.7):
1. Running the identifier: python micelle_identifier.py -m micelle_file.txt -a connection_file.txt
    a. The output will be the text specifying the micelle shape identified and a visual plot of the points

The above files do not need to be in a ".txt" format. Any file will suffice.


#################################################################
To build the documentation:
0. Install Doyxgen and graphviz: sudo apt-get install doxygen graphviz
1. Run the following: doxygen doxyfile
2. Open the docs/html folder and click on the index.html file to view in a browser