Merge pull request #11 from ncats/feat_revision

.gitignore

@@ -42,3 +42,134 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

README.md

@@ -1,8 +1,19 @@
 # SmartGraph API
 
-## Overview
+## Cite Us
 
-The repository manages the source code of SmartGraph API used for the ASPIRE program.
+[Zahoránszky-Kőhalmi G, Walker B, Miller N, Yang B, Penna DVL, Binder J, et al. SmartGraph API: Programmatic Knowledge Mining in Network- Pharmacology Setting. ChemRxiv. 2024; doi:10.26434/chemrxiv-2024-0psx3 This content is a preprint and has not been peer-reviewed.](https://chemrxiv.org/engage/chemrxiv/article-details/65a18b9d9138d23161c824ec)
+
+
+<BR>
+
+<img src="data/images/FigureS1.png" alt="SmartGraph API Main Functionalities" style="height: 400; width:600;"/>
+
+<BR>
+
+<img src="data/images/Fig1.png" alt="SmartGraph API Case Study" style="400: ; width:600;"/>
+
+<BR>
 
 ## Local Deployment
 
@@ -46,3 +57,11 @@ In the command above, replace the "path_to_config_template_files" with the actua
 ## Documentation via SWAGGER
 
 Visit `http://127.0.0.1:5070/docs` or use the URL respective to the deployment type (CI/QA/Prod).
+
+
+## License Related Remarks
+
+
+This repository contains a `data` subdirectory, all of its content (recursively) falls under the CC BY 4.0 International license as indicated by the `data/LICENSE` file. All other files and directories fall under the MIT source code license as indicated by the `LICENSE` file in the root of this repository. 
+
+Please observe the `data/NOTES` and `NOTES` file (latter in the root of this repository) for additional information in relevant to license issues.