Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Design document finalize #1

Open
wants to merge 87 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 70 commits
Commits
Show all changes
87 commits
Select commit Hold shift + click to select a range
16d8749
git ignore file added
tekrajchhetri Apr 23, 2024
3719bf4
init design doc
tekrajchhetri Apr 23, 2024
3d89f2c
Updated sequence diagram to use mermaid
tekrajchhetri Apr 23, 2024
79c3422
Why BrainyPedia section added
tekrajchhetri Apr 23, 2024
68f2099
readme updated with timelines
tekrajchhetri Apr 24, 2024
978ea60
usage scenario added + use case in progress
tekrajchhetri Apr 25, 2024
e1eee89
date corrected
tekrajchhetri Apr 25, 2024
efe8e36
description updated based on dorota's comment
tekrajchhetri Apr 25, 2024
181c99b
decription updated + missing image added
tekrajchhetri Apr 26, 2024
634f920
target audience added
tekrajchhetri Apr 26, 2024
3bff894
ingest arch added
tekrajchhetri Apr 26, 2024
fbf3dd5
brainstromed use cases added - todo: add corresponding description
tekrajchhetri May 14, 2024
993821b
architecture design updated
tekrajchhetri May 28, 2024
4aca0b5
fixed repetition
tekrajchhetri May 28, 2024
96ec749
schema flexibility example added
tekrajchhetri May 29, 2024
ca3fbc4
BrainyPedia renamed to BrainKB
tekrajchhetri May 29, 2024
1d39afa
logo added
tekrajchhetri May 29, 2024
f79d57e
v1 completed
tekrajchhetri May 29, 2024
e96ec3a
fixed dorota comment
tekrajchhetri May 29, 2024
012e904
logo added
tekrajchhetri May 30, 2024
cc154bc
codespell config added
tekrajchhetri May 30, 2024
3570073
Node version updated
tekrajchhetri May 30, 2024
bf08d21
codespell output write added
tekrajchhetri May 30, 2024
d9bd936
Node.js 16 actions are deprecated. Please update the following action…
tekrajchhetri May 30, 2024
d878d5a
Update codespell.yml
tekrajchhetri May 30, 2024
43e8f2e
code spell check
tekrajchhetri May 30, 2024
d075272
description updated based on received comment
tekrajchhetri May 30, 2024
b86f974
Merge branch 'design-doc' of github.com:sensein/brainkb-design-docume…
tekrajchhetri May 30, 2024
a491a85
Node version updated
tekrajchhetri May 30, 2024
89493a5
EBRAINS and Open Metadata Initiative information added
tekrajchhetri May 30, 2024
f8c8a78
l1 and l2 layer description removed
tekrajchhetri May 30, 2024
9104024
IP changed to domain name
tekrajchhetri May 30, 2024
ff42798
removed workflows-merged: yarikoptic pull request
tekrajchhetri May 30, 2024
a2f37a9
Models description updated
tekrajchhetri May 30, 2024
7184a35
Precondition updated
tekrajchhetri May 30, 2024
50e9b15
updated based on dorota feedback
tekrajchhetri May 30, 2024
5e759c2
Update README.md --accepted suggested change from dorota
tekrajchhetri May 30, 2024
09b586c
accepted suggested change from @djarecka
tekrajchhetri May 30, 2024
4e523f8
suggested changes from dorota
tekrajchhetri May 31, 2024
ec5a74a
Update README.md
tekrajchhetri May 31, 2024
e2f5223
Update README.md
tekrajchhetri May 31, 2024
9378e10
Update README.md
tekrajchhetri May 31, 2024
ef990af
Update README.md
tekrajchhetri May 31, 2024
7a44237
logo+link prediction image added
tekrajchhetri Jun 7, 2024
842f2db
link prediction description updatd based on the comment of dorota
tekrajchhetri Jun 7, 2024
a33ae27
figure updated
tekrajchhetri Jun 7, 2024
ba60c9c
architecture description updated
tekrajchhetri Jun 7, 2024
c6bc9e0
moved principles from BICAN Knowledge Graph slides
tekrajchhetri Jun 10, 2024
fa33601
entity card image updated
tekrajchhetri Jun 10, 2024
e9ca2e7
git repo link added
tekrajchhetri Jun 10, 2024
bfac903
ecosystem diagram--in progress added
tekrajchhetri Jun 12, 2024
921802c
Update README.md
tekrajchhetri Jun 12, 2024
ad6b882
figure updated
tekrajchhetri Jun 12, 2024
655d9b0
figure updated - updte 1
tekrajchhetri Jun 12, 2024
d733d68
updated ecosystem diagram
tekrajchhetri Jun 18, 2024
0932f73
visio diagram added
tekrajchhetri Jun 18, 2024
9b83870
re-ordered
tekrajchhetri Jul 8, 2024
3da5a87
Update README.md
tekrajchhetri Jul 8, 2024
df178e1
Update README.md
tekrajchhetri Jul 8, 2024
e12ba9d
Update README.md
tekrajchhetri Jul 8, 2024
b59ea54
Update README.md
tekrajchhetri Jul 8, 2024
4d4c1f6
Update README.md
tekrajchhetri Jul 8, 2024
4af7b11
updated example
tekrajchhetri Jul 8, 2024
c930195
Merge branch 'design-doc' of github.com:sensein/brainkb-design-docume…
tekrajchhetri Jul 8, 2024
799890c
example added
tekrajchhetri Jul 8, 2024
8b2168c
code spell error fixed
tekrajchhetri Jul 8, 2024
7a1e958
hosting infrastructure added based on tyler's suggestion
tekrajchhetri Jul 15, 2024
88db560
work plan table added.
tekrajchhetri Jul 15, 2024
951da7d
description updated
tekrajchhetri Jul 15, 2024
84ad0de
removed api endpoints for now
tekrajchhetri Jul 15, 2024
eed6a55
Update README.md
tekrajchhetri Jul 31, 2024
52f5b64
Update README.md
tekrajchhetri Aug 1, 2024
a62da03
Update README.md
tekrajchhetri Aug 1, 2024
bb30a98
Update README.md
tekrajchhetri Aug 1, 2024
5a715c9
Update README.md
tekrajchhetri Aug 1, 2024
2ce17c3
Update README.md
tekrajchhetri Aug 1, 2024
faa24aa
Update README.md
tekrajchhetri Aug 1, 2024
0c7e01b
updated image based on review comment
tekrajchhetri Aug 1, 2024
3fa113b
updated vdx file based on Isaac's comment
tekrajchhetri Aug 1, 2024
1122f85
image updated based on Issac's review
tekrajchhetri Aug 1, 2024
18a143b
Updated ingest architecture based on Issac's comment
tekrajchhetri Aug 1, 2024
30bec42
updated as per Isaac's suggestion
tekrajchhetri Aug 1, 2024
22ec0a1
Updated Target Audience - Dorota's comment
tekrajchhetri Aug 1, 2024
9e6ecb2
removed research
tekrajchhetri Aug 1, 2024
a909337
Update cognitive_burden.png
tekrajchhetri Aug 1, 2024
6f0dedd
description updated based on Dorota's comment
tekrajchhetri Aug 1, 2024
26d729b
codespell error corrected
tekrajchhetri Aug 1, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
214 changes: 214 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,214 @@
.idea/
.DS_Store
# Created by https://www.gitignore.io/api/macos,linux,django,python,pycharm

### Django ###
*.log
*.pot
*.pyc
__pycache__/
local_settings.py
db.sqlite3
media

### Linux ###
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

### macOS ###
*.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### PyCharm ###
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff:
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/dictionaries

# Sensitive or high-churn files:
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.xml
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml

# Gradle:
.idea/**/gradle.xml
.idea/**/libraries

# CMake
cmake-build-debug/

# Mongo Explorer plugin:
.idea/**/mongoSettings.xml

## File-based project format:
*.iws

## Plugin-specific files:

# IntelliJ
/out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Cursive Clojure plugin
.idea/replstate.xml

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

### PyCharm Patch ###
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721

# *.iml
# modules.xml
# .idea/misc.xml
# *.ipr

# Sonarlint plugin
.idea/sonarlint

### Python ###
# Byte-compiled / optimized / DLL files
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg

# 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/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/

# Translations
*.mo

# Django stuff:

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# dotenv
.env

# virtualenv
.venv
venv/
ENV/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# End of https://www.gitignore.io/api/macos,linux,django,python,pycharm
304 changes: 303 additions & 1 deletion README.md

Large diffs are not rendered by default.

Binary file added acc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added brainkb-arch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added circular_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added cognitive_burden.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ecosystem.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added entity-card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ingest.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added link_prediction.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added visio/BrainKB-Ecosystem.vsdx
Binary file not shown.
Loading