baquer / Machine-Olf-Action

Machine-OLF-action: a machine learning-driven computational framework

Machine-OLF-action: a machine learning-driven computational framework

Description of all the folders present in the repository

Code - contains source code of the application

To run application using the source code

1. Clone the git repository
2. All the source code is present in the "Code" folder.
3. Download cond/pip packages required by code using "environment.yml" file present in the Config/CondaEnvironment/ folder.
4. Make sure you have conda available on your system. If not download conda first and then create a new conda environment using command "conda env create -f environment.yml"
5. You can use your favourite IDE (like PyCharm) with the above newly created conda environment to run code.
6. Run "run.py" file located at Machine-Olf-Action/Code/run.py to start the flask application server which then opens the application in your default browser.

Config - contains confiuration files needed to run and buid the executables of application

• CondaEnvironment- Contains OS specific conda environment file with list of packages to replicate environment on your machine
• Pyinstaller - Details on how to create executable files of different platforms from the source code

Documents - documentation of the application

Documentation related to the application

Executables - executables of the application

To directly run the application, go to Executables folder and download executable for the respective platform using the instructions provided in the "Download.md" file

Want to Report an Issue or Request a New Feature?

To report any issues click on the Issues tab on git hub and submit a new issue. To learn what to specify: browse to github/ISSUE_TEMPLATE/