=============
KADMOS README
=============

1. Folder Structure
2. Packages
3. Setup




################################

1. Folder Structure

The KADMOS folder structure looks as follows:

pyKADMOS
|
|----- KNOWLEDGE_BASE/		>> contains all knowledge bases
|
|----- doc/ 				>> contains documentation files
|
|----- packages/ 			>> contains external packages that are not installed through pip
|
|----- sample/ 				>> contains all the code of interest (main classes of KADMOS)
|		|
|		|----- static/		>> contains all static files
|
|----- scripts/ 			>> contains scripts to be executed for KADMOS operation
|
|----- temp/ 				>> contains temporary files such as genrated latex and pdf files, should have subfolders according to project
|
|----- tests/ 				>> used for testing
|
|----- LICENSE.txt 			>> license information
|
|----- README.txt           >> all relevant information regarding KADMOS and its use
|
|----- requirements.txt 	>> all required python packages that will be installed through e.g. pip
|
|----- setup.py 			>> package and distribution management


################################

2. Packages

KADMOS utilizes the following packages:

...

################################

3. Setup