initialize the repo

clowder-framework · Mar 2, 2023 · 44547ef · 44547ef
commit 44547ef
Show file tree

Hide file tree

Showing 178 changed files with 2,126,180 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,133 @@
+# 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/
+
+.idea
+sentiment_analysis/numberbatch-en-17.04b.txt
+.DS_Store
diff --git a/README.md b/README.md
@@ -0,0 +1,183 @@
+# smm-extractor
+This repo includes a few popular [Social Media Macroscope Extractors](https://smm.ncsa.illinois.edu/) such as 
+Sentiment Analysis, Network Visualization, Text Preprocessing, Topic Modeling, Name Entity Recognition, and etc.
+
+## Build
+To build Clowder SMM extractors, make sure to use the correct dockerfile in each of the extractor folder (**extractor.
+dockerfile**). 
+* Note you can also build SMM extractor (**dockerfile**) that is being used independently of Clowder but on the 
+  SMM system.
+
+Some of the useful command:
+
+Build
+```angular2html
+docker build -f extractor.dockerfile -t socialmediamacroscope/network_analysis_extractor:latest .
+```
+
+Push
+```angular2html
+docker push socialmediamacroscope/network_analysis_extractor:latest
+```
+
+## Deploy
+For how to deploy Clowder extractors please refer to the official [Documentation](https://clowder-framework. readthedocs.io/en/latest/develop/extractors.html#.)
+
+You can access the latest pre-built SMM extractors on docker.io:
+
+[socialmediamacroscope/sentiment_analysis_extractor](https://hub.docker.com/repository/docker/socialmediamacroscope/sentiment_analysis_extractor/general)
+[socialmediamacroscope/topic_modeling_extractor](https://hub.docker.com/repository/docker/socialmediamacroscope/topic_modeling_extractor/general)
+[socialmediamacroscope/network_analysis_extractor](https://hub.docker.com/repository/docker/socialmediamacroscope/network_analysis_extractor/general)
+[socialmediamacroscope/preprocessing_extractor](https://hub.docker.com/repository/docker/socialmediamacroscope/preprocessing_extractor/general)
+[socialmediamacroscope/name_entity_recognition_extractor](https://hub.docker.com/repository/docker/socialmediamacroscope/name_entity_recognition_extractor/general)
+
+To include those extractors with docker-compose:
+```
+  smm-sentiment:
+    image: socialmediamacroscope/sentiment_analysis_extractor:latest
+    restart: unless-stopped
+    networks:
+      - clowder
+    depends_on:
+      - rabbitmq
+      - clowder
+    environment:
+      - RABBITMQ_URI=${RABBITMQ_URI:-amqp://guest:guest@rabbitmq/%2F}
+
+  smm-preprocessing:
+    image: socialmediamacroscope/preprocessing_extractor:latest
+    restart: unless-stopped
+    networks:
+      - clowder
+    depends_on:
+      - rabbitmq
+      - clowder
+    environment:
+      - RABBITMQ_URI=${RABBITMQ_URI:-amqp://guest:guest@rabbitmq/%2F}
+
+  name-entity-recognition:
+    image: socialmediamacroscope/name_entity_recognition_extractor:latest
+    restart: unless-stopped
+    networks:
+      - clowder
+    depends_on:
+      - rabbitmq
+      - clowder
+    environment:
+      - RABBITMQ_URI=${RABBITMQ_URI:-amqp://guest:guest@rabbitmq/%2F}
+
+  network-analysis:
+    image: socialmediamacroscope/network_analysis_extractor:latest
+    restart: unless-stopped
+    networks:
+      - clowder
+    depends_on:
+      - rabbitmq
+      - clowder
+    environment:
+      - RABBITMQ_URI=${RABBITMQ_URI:-amqp://guest:guest@rabbitmq/%2F}
+
+  topic-modeling:
+    image: socialmediamacroscope/topic_modeling_extractor:latest
+    restart: unless-stopped
+    networks:
+      - clowder
+    depends_on:
+      - rabbitmq
+      - clowder
+    environment:
+      - RABBITMQ_URI=${RABBITMQ_URI:-amqp://guest:guest@rabbitmq/%2F}
+```
+
+
+## Submit file to extractors
+# smm-extractor
+This repo includes a few popular [Social Media Macroscope Extractors](https://smm.ncsa.illinois.edu/) such as 
+Sentiment Analysis, Network Visualization, Text Preprocessing, Topic Modeling, Name Entity Recognition, and etc.
+
+## Build
+To build Clowder SMM extractors, make sure to use the correct dockerfile in each of the extractor folder (**extractor.
+dockerfile**). 
+* Note you can also build SMM extractor (**dockerfile**) that is being used independently of Clowder but on the 
+  SMM system.
+
+Some of the useful command:
+
+Build
+```angular2html
+docker build -f extractor.dockerfile -t socialmediamacroscope/network_analysis_extractor:latest .
+```
+
+Push
+```angular2html
+docker push socialmediamacroscope/network_analysis_extractor:latest
+```
+
+## Deploy
+For how to deploy Clowder extractors please refer to the official [Documentation](https://clowder-framework. readthedocs.io/en/latest/develop/extractors.html#.)
+
+You can access the latest pre-built SMM extractors on docker.io:
+
+[socialmediamacroscope/sentiment_analysis_extractor](https://hub.docker.com/repository/docker/socialmediamacroscope/sentiment_analysis_extractor/general)
+[socialmediamacroscope/topic_modeling_extractor](https://hub.docker.com/repository/docker/socialmediamacroscope/topic_modeling_extractor/general)
+[socialmediamacroscope/network_analysis_extractor](https://hub.docker.com/repository/docker/socialmediamacroscope/network_analysis_extractor/general)
+[socialmediamacroscope/preprocessing_extractor](https://hub.docker.com/repository/docker/socialmediamacroscope/preprocessing_extractor/general)
+[socialmediamacroscope/name_entity_recognition_extractor](https://hub.docker.com/repository/docker/socialmediamacroscope/name_entity_recognition_extractor/general)
+
+To include those extractors with docker-compose:
+```
+  smm-sentiment:
+    image: socialmediamacroscope/sentiment_analysis_extractor:latest
+    restart: unless-stopped
+    networks:
+      - clowder
+    depends_on:
+      - rabbitmq
+      - clowder
+    environment:
+      - RABBITMQ_URI=${RABBITMQ_URI:-amqp://guest:guest@rabbitmq/%2F}
+
+  smm-preprocessing:
+    image: socialmediamacroscope/preprocessing_extractor:latest
+    restart: unless-stopped
+    networks:
+      - clowder
+    depends_on:
+      - rabbitmq
+      - clowder
+    environment:
+      - RABBITMQ_URI=${RABBITMQ_URI:-amqp://guest:guest@rabbitmq/%2F}
+
+  name-entity-recognition:
+    image: socialmediamacroscope/name_entity_recognition_extractor:latest
+    restart: unless-stopped
+    networks:
+      - clowder
+    depends_on:
+      - rabbitmq
+      - clowder
+    environment:
+      - RABBITMQ_URI=${RABBITMQ_URI:-amqp://guest:guest@rabbitmq/%2F}
+
+  network-analysis:
+    image: socialmediamacroscope/network_analysis_extractor:latest
+    restart: unless-stopped
+    networks:
+      - clowder
+    depends_on:
+      - rabbitmq
+      - clowder
+    environment:
+      - RABBITMQ_URI=${RABBITMQ_URI:-amqp://guest:guest@rabbitmq/%2F}
+
+  topic-modeling:
+    image: socialmediamacroscope/topic_modeling_extractor:latest
+    restart: unless-stopped
+    networks:
+      - clowder
+    depends_on:
+      - rabbitmq
+      - clowder
+    environment:
+      - RABBITMQ_URI=${RABBITMQ_URI:-amqp://guest:guest@rabbitmq/%2F}
+```