SciSketch

https://github.com/yale-nlp/scisketch

Admin

SciSketch is an open-source framework for generating high-quality schematic diagrams directly from...

Tokens:467

Snippets:6

Trust Score:8.2

License:MIT

Update:1 month ago

Show doc for...

Tokens:

Raw

### Install project dependencies

Source: https://github.com/yale-nlp/scisketch/blob/main/README.md

Install required Python packages using the provided requirements file.

```bash
pip install -r requirements.txt
```

--------------------------------

### Clone the SCISKETCH repository

Source: https://github.com/yale-nlp/scisketch/blob/main/README.md

Initial step to download the project source code from GitHub.

```bash
git clone https://github.com/yale-nlp/SciSketch.git
cd scisketch
```

--------------------------------

### View project directory structure

Source: https://github.com/yale-nlp/scisketch/blob/main/README.md

Overview of the file organization within the SCISKETCH repository.

```text
SciSketch/
├── bin/                        # Scripts to generate the diagram
│   ├── generate_diagrams.sh
├── input_images/               # Directory to store the empirical images 
├── samples/                    # Directory to store the parsed paper contents
│   ├── parsed_papers.sh
├── srs/
│   ├── configs.py               # configurations including foundation model for each module
│   ├── custom_main.py           # main entry point
│   ├── diagram_handler.py       # handler for diagram generation
│   ├── file_util.py             # file related util functions
│   ├── foundation_model_util.py # foundation model related util functions
│   ├── prompts.py               # all the prompts used in the diagram generation
│   ├── string_util.py           # string related utils
│   ├── util.py                  # comman utils
│   ├── xml_util.py              # xml related utils
├── assets/                      # Images
├── requirements.txt
├── .env
└── README.md
```

--------------------------------

### Run diagram generation

Source: https://github.com/yale-nlp/scisketch/blob/main/README.md

Execute the generation script for a specific paper sample.

```bash
bash bin/generate_diagrams.sh --sample_id paper_name
```

Tokens:

Raw