Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -158,3 +158,6 @@ cython_debug/
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

# VSCode
*DS_Store
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Visualization Core (vuecore) library
## ![VueCore Logo](https://raw.githubusercontent.com/Multiomics-Analytics-Group/vuecore/HEAD/docs/images/logo/vuecore_logo.svg)

Visualization library for omics data.
<p align="center">
VueCore is a Python package for creating interactive and static visualizations of multi-omics data
</p>

See also acore and vuegen.
VueCore is part of a broader ecosystem of tools for multi-omics analysis, working in conjunction with [ACore][acore] and [VueGen][vuegen] to enable end-to-end data processing, visualization, and reporting.

## Installation

Expand All @@ -22,3 +24,6 @@ editable mode:
# cd vuecore
pip install -e '.[dev]'
```

[vuegen]: https://github.com/Multiomics-Analytics-Group/vuegen
[acore]: https://github.com/Multiomics-Analytics-Group/acore
3 changes: 3 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ reference
# builds
_build
jupyter_execute

# VS Code
.DS_Store
5 changes: 3 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
"sphinx.ext.intersphinx",
"sphinx_new_tab_link",
"myst_nb",
"sphinx_copybutton",
]

# https://myst-nb.readthedocs.io/en/latest/computation/execute.html
Expand Down Expand Up @@ -99,8 +100,8 @@
# https://github.com/executablebooks/MyST-NB/blob/master/docs/conf.py
# html_title = ""
html_theme = "sphinx_book_theme"
# html_logo = "_static/logo-wide.svg"
# html_favicon = "_static/logo-square.svg"
html_logo = "images/logo/vuecore_logo.svg"
html_favicon = "images/logo/vuecore_logo_small.svg"
html_theme_options = {
"github_url": "https://github.com/Multiomics-Analytics-Group/vuecore",
"repository_url": "https://github.com/Multiomics-Analytics-Group/vuecore",
Expand Down
Binary file added docs/images/logo/vuecore_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading