diff --git a/docs/assets/demo/demo-1.html b/docs/assets/demo/demo-1.html new file mode 100644 index 0000000..236bf99 --- /dev/null +++ b/docs/assets/demo/demo-1.html @@ -0,0 +1,894 @@ + + + + + Awesome-pyecharts + + + + +
+ + + diff --git a/docs/assets/facebook_cover_photo_1.png b/docs/assets/logo/facebook_cover_photo_1.png similarity index 100% rename from docs/assets/facebook_cover_photo_1.png rename to docs/assets/logo/facebook_cover_photo_1.png diff --git a/docs/assets/facebook_cover_photo_2.png b/docs/assets/logo/facebook_cover_photo_2.png similarity index 100% rename from docs/assets/facebook_cover_photo_2.png rename to docs/assets/logo/facebook_cover_photo_2.png diff --git a/docs/assets/facebook_profile_image.png b/docs/assets/logo/facebook_profile_image.png similarity index 100% rename from docs/assets/facebook_profile_image.png rename to docs/assets/logo/facebook_profile_image.png diff --git a/docs/assets/favicon.png b/docs/assets/logo/favicon.png similarity index 100% rename from docs/assets/favicon.png rename to docs/assets/logo/favicon.png diff --git a/docs/assets/instagram_profile_image.png b/docs/assets/logo/instagram_profile_image.png similarity index 100% rename from docs/assets/instagram_profile_image.png rename to docs/assets/logo/instagram_profile_image.png diff --git a/docs/assets/linkedin_banner_image_1.png b/docs/assets/logo/linkedin_banner_image_1.png similarity index 100% rename from docs/assets/linkedin_banner_image_1.png rename to docs/assets/logo/linkedin_banner_image_1.png diff --git a/docs/assets/linkedin_banner_image_2.png b/docs/assets/logo/linkedin_banner_image_2.png similarity index 100% rename from docs/assets/linkedin_banner_image_2.png rename to docs/assets/logo/linkedin_banner_image_2.png diff --git a/docs/assets/linkedin_profile_image.png b/docs/assets/logo/linkedin_profile_image.png similarity index 100% rename from docs/assets/linkedin_profile_image.png rename to docs/assets/logo/linkedin_profile_image.png diff --git a/docs/assets/logo.png b/docs/assets/logo/logo.png similarity index 100% rename from docs/assets/logo.png rename to docs/assets/logo/logo.png diff --git a/docs/assets/logo.svg b/docs/assets/logo/logo.svg similarity index 100% rename from docs/assets/logo.svg rename to docs/assets/logo/logo.svg diff --git a/docs/assets/logo_badge.png b/docs/assets/logo/logo_badge.png similarity index 100% rename from docs/assets/logo_badge.png rename to docs/assets/logo/logo_badge.png diff --git a/docs/assets/logo_badge.svg b/docs/assets/logo/logo_badge.svg similarity index 100% rename from docs/assets/logo_badge.svg rename to docs/assets/logo/logo_badge.svg diff --git a/docs/assets/logo_transparent.png b/docs/assets/logo/logo_transparent.png similarity index 100% rename from docs/assets/logo_transparent.png rename to docs/assets/logo/logo_transparent.png diff --git a/docs/assets/logo_transparent.svg b/docs/assets/logo/logo_transparent.svg similarity index 100% rename from docs/assets/logo_transparent.svg rename to docs/assets/logo/logo_transparent.svg diff --git a/docs/assets/pinterest_board_photo.png b/docs/assets/logo/pinterest_board_photo.png similarity index 100% rename from docs/assets/pinterest_board_photo.png rename to docs/assets/logo/pinterest_board_photo.png diff --git a/docs/assets/pinterest_profile_image.png b/docs/assets/logo/pinterest_profile_image.png similarity index 100% rename from docs/assets/pinterest_profile_image.png rename to docs/assets/logo/pinterest_profile_image.png diff --git a/docs/assets/twitter_header_photo_1.png b/docs/assets/logo/twitter_header_photo_1.png similarity index 100% rename from docs/assets/twitter_header_photo_1.png rename to docs/assets/logo/twitter_header_photo_1.png diff --git a/docs/assets/twitter_header_photo_2.png b/docs/assets/logo/twitter_header_photo_2.png similarity index 100% rename from docs/assets/twitter_header_photo_2.png rename to docs/assets/logo/twitter_header_photo_2.png diff --git a/docs/assets/twitter_profile_image.png b/docs/assets/logo/twitter_profile_image.png similarity index 100% rename from docs/assets/twitter_profile_image.png rename to docs/assets/logo/twitter_profile_image.png diff --git a/docs/assets/youtube_profile_image.png b/docs/assets/logo/youtube_profile_image.png similarity index 100% rename from docs/assets/youtube_profile_image.png rename to docs/assets/logo/youtube_profile_image.png diff --git a/docs/changelog.md b/docs/changelog.md index f5cd521..db78094 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,5 +1,11 @@ # Kirsche Changelog -## 2021-05-20, 0.1.0 +## 2021-09-21 + +Added: + +- Visualizations! + +## 2021-09-16, 0.1.0 First version! \ No newline at end of file diff --git a/docs/references/visualize.md b/docs/references/visualize.md new file mode 100644 index 0000000..91136bf --- /dev/null +++ b/docs/references/visualize.md @@ -0,0 +1,3 @@ +## visualize + +::: kirsche.visualize \ No newline at end of file diff --git a/docs/tutorials/assets/visualizations/visualization-demo-1.gif b/docs/tutorials/assets/visualizations/visualization-demo-1.gif new file mode 100644 index 0000000..23ba200 Binary files /dev/null and b/docs/tutorials/assets/visualizations/visualization-demo-1.gif differ diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index c2f306a..7267068 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -2,17 +2,63 @@ Some tutorials are provided here in this section. +## Install + +``` +pip install kirsche +``` + +??? warning "Install in an Environment" + + Unless you are using this in a temporary machine like a docker container, it is recommended to install this in an environment. + + For example, using conda, we can create an environment called `kirsche` or any other name you prefer, + + ``` + conda create -n "kirsche" python=3.7 pip + ``` + + then activate the environment + + ``` + conda activate kirsche + ``` + + Install kirsche in this environment + + ``` + pip install kirsche + ``` + +### Visualizations + +Suppose we have a bib file called `test.bib`, and we would like to generate an html file called `test.html`, + +=== "Command" + + ``` + kirsche visualization -sb "test.bib" -th "test.html" + ``` + + Open the `test.html` file in your browser. + +=== "Results" + + + ![](assets/visualizations/visualization-demo-1.gif) + + ### Download metadata only Using DOIs: -```python +``` kirsche metadata -p "10.1016/j.sna.2020.112529" -p "10.1152/jn.00208.2014" -m save/to/file/path ``` Using a bib file: -```python +``` kirsche metadata -b path/to/your/bib/file -m save/to/file/path ``` @@ -21,12 +67,12 @@ kirsche metadata -b path/to/your/bib/file -m save/to/file/path Using DOIs: -```python +``` kirsche connections -p "10.1016/j.sna.2020.112529" -p "10.1152/jn.00208.2014" -c save/to/file/path ``` Using a bib file: -```python +``` kirsche connections -b path/to/your/bib/file -c save/to/file/path ``` diff --git a/docs/tutorials/use-in-code.md b/docs/tutorials/use-in-code.md index 94cc69f..3f57bbc 100644 --- a/docs/tutorials/use-in-code.md +++ b/docs/tutorials/use-in-code.md @@ -1,4 +1,3 @@ # Use in Code -## Download Data - +The command line tool covers most of the use cases. If more customizations is desired, please refer to [References](../references/index.md) for details about the utilities. diff --git a/kirsche/command.py b/kirsche/command.py index 416984c..a0d3b1b 100644 --- a/kirsche/command.py +++ b/kirsche/command.py @@ -13,7 +13,7 @@ from kirsche.dataset import DataViews from kirsche.utils.io import load_json from kirsche.utils.bib import load_bib -from kirsche.visalize import make_chart, PaperGraph, visualize +from kirsche.visualize import make_chart, PaperGraph, visualize logger.remove() diff --git a/kirsche/visalize.py b/kirsche/visualize.py similarity index 100% rename from kirsche/visalize.py rename to kirsche/visualize.py diff --git a/mkdocs.yml b/mkdocs.yml index 8999481..084bc87 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,8 +36,8 @@ theme: font: text: Roboto code: Roboto Mono - favicon: assets/logo.png - logo: assets/logo_badge.svg + favicon: assets/logo/logo.png + logo: assets/logo/logo_badge.svg @@ -52,6 +52,7 @@ markdown_extensions: - pymdownx.tasklist - toc: permalink: "ยค" + - pymdownx.details plugins: - autorefs @@ -75,6 +76,7 @@ nav: - "Home": index.md - "Tutorials": - "Tutorials": tutorials/index.md + - "Use in Python Code": tutorials/use-in-code.md - References: - "Introduction": references/index.md - "Commandline": @@ -83,6 +85,8 @@ nav: - "Download": references/download.md - "Connect": - "Connect": references/connect.md + - "Visualize": + - "Visualize": references/visualize.md - "Dataset": - "Dataset": references/dataset.md - "Utils":