diff --git a/.gitignore b/.gitignore index 68bc17f..d3abe60 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/README.md b/README.md index 4d23db0..f4ae11b 100644 --- a/README.md +++ b/README.md @@ -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. +

+ VueCore is a Python package for creating interactive and static visualizations of multi-omics data +

-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 @@ -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 \ No newline at end of file diff --git a/docs/.gitignore b/docs/.gitignore index 08a2f75..f1ff8c4 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -3,3 +3,6 @@ reference # builds _build jupyter_execute + +# VS Code +.DS_Store \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index a08d96a..66522e3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 @@ -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", diff --git a/docs/images/logo/vuecore_logo.png b/docs/images/logo/vuecore_logo.png new file mode 100644 index 0000000..00c2628 Binary files /dev/null and b/docs/images/logo/vuecore_logo.png differ diff --git a/docs/images/logo/vuecore_logo.svg b/docs/images/logo/vuecore_logo.svg new file mode 100644 index 0000000..e49b2ac --- /dev/null +++ b/docs/images/logo/vuecore_logo.svg @@ -0,0 +1,38350 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/logo/vuecore_logo_small.png b/docs/images/logo/vuecore_logo_small.png new file mode 100644 index 0000000..899bbc3 Binary files /dev/null and b/docs/images/logo/vuecore_logo_small.png differ diff --git a/docs/images/logo/vuecore_logo_small.svg b/docs/images/logo/vuecore_logo_small.svg new file mode 100644 index 0000000..f6a99d4 --- /dev/null +++ b/docs/images/logo/vuecore_logo_small.svg @@ -0,0 +1,5446 @@ + + + + + + diff --git a/pyproject.toml b/pyproject.toml index 16e5363..60a1c09 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -47,6 +47,7 @@ docs = [ "ipywidgets", "sphinx-new-tab-link!=0.2.2", "jupytext", + "sphinx-copybutton", ] dev = [ "black",