Skip to content

Commit

Permalink
fixed bugs
Browse files Browse the repository at this point in the history
  • Loading branch information
emptymalei committed Sep 21, 2021
1 parent 02ae2e1 commit 642422c
Show file tree
Hide file tree
Showing 29 changed files with 962 additions and 10 deletions.
894 changes: 894 additions & 0 deletions docs/assets/demo/demo-1.html

Large diffs are not rendered by default.

File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
8 changes: 7 additions & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
@@ -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!
3 changes: 3 additions & 0 deletions docs/references/visualize.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## visualize

::: kirsche.visualize
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 50 additions & 4 deletions docs/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
```
3 changes: 1 addition & 2 deletions docs/tutorials/use-in-code.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion kirsche/command.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
File renamed without changes.
8 changes: 6 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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



Expand All @@ -52,6 +52,7 @@ markdown_extensions:
- pymdownx.tasklist
- toc:
permalink: "¤"
- pymdownx.details

plugins:
- autorefs
Expand All @@ -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":
Expand All @@ -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":
Expand Down

0 comments on commit 642422c

Please sign in to comment.