Skip to content

Commit 3313ece

Browse files
committed
Update documentation
1 parent ec7b8c7 commit 3313ece

File tree

3 files changed

+20
-2
lines changed

3 files changed

+20
-2
lines changed

COMMANDS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
- [Examples](#examples)
99
- [Start an analysis with CSV reports only](#start-an-analysis-with-csv-reports-only)
1010
- [Start an analysis with Jupyter reports only](#start-an-analysis-with-jupyter-reports-only)
11+
- [Start an analysis with Python reports only](#start-an-analysis-with-python-reports-only)
1112
- [Start an analysis with PDF generation](#start-an-analysis-with-pdf-generation)
1213
- [Start an analysis without importing git log data](#start-an-analysis-without-importing-git-log-data)
1314
- [Only run setup and explore the Graph manually](#only-run-setup-and-explore-the-graph-manually)
@@ -102,6 +103,14 @@ If only the Jupyter reports are needed e.g. when the CSV reports had already bee
102103
./../../scripts/analysis/analyze.sh --report Jupyter
103104
```
104105

106+
#### Start an analysis with Python reports only
107+
108+
If you only need Python reports, e.g. to skip Chromium Browser dependency, the this can be done with:
109+
110+
```shell
111+
./../../scripts/analysis/analyze.sh --report Python
112+
```
113+
105114
#### Start an analysis with PDF generation
106115

107116
Note: Generating a PDF from a Jupyter notebook using [nbconvert](https://nbconvert.readthedocs.io) takes some time and might even fail due to a timeout error.

GETTING_STARTED.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,22 @@ Use these optional command line options as needed:
8484
./../../scripts/analysis/analyze.sh --report Csv
8585
```
8686
87-
- Jupyter notebook reports when Python and Conda are installed:
87+
- Jupyter notebook reports when Python and Conda are installed (and Chromium Browser for PDF generation):
8888
8989
```shell
9090
./../../scripts/analysis/analyze.sh --report Jupyter
9191
```
9292
93+
- Python reports when Python and Conda are installed (without Chromium Browser for PDF generation):
94+
95+
```shell
96+
./../../scripts/analysis/analyze.sh --report Python
97+
```
98+
9399
- Graph visualizations when Node.js and npm are installed:
94100
95101
```shell
96-
./../../scripts/analysis/analyze.sh --report Jupyter
102+
./../../scripts/analysis/analyze.sh --report Visualization
97103
```
98104
99105
- All reports with Python, Conda, Node.js and npm installed:

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,9 @@ The [Code Structure Analysis Pipeline](./.github/workflows/internal-java-code-an
148148
- [Neo4j Python Driver](https://neo4j.com/docs/api/python-driver)
149149
- [openTSNE](https://github.com/pavlin-policar/openTSNE)
150150
- [wordcloud](https://github.com/amueller/word_cloud)
151+
- [umap](https://umap-learn.readthedocs.io)
152+
- [scikit-learn](https://scikit-learn.org)
153+
- [optuna](https://optuna.org)
151154
- [Graph Visualization](./graph-visualization/README.md) uses [node.js](https://nodejs.org/de) and the dependencies listed in [package.json](./graph-visualization/package.json).
152155
- [HPCC-Systems (High Performance Computing Cluster) Web-Assembly (JavaScript)](https://github.com/hpcc-systems/hpcc-js-wasm) containing a wrapper for GraphViz to visualize graph structures.
153156
- [GraphViz](https://gitlab.com/graphviz/graphviz) for CLI Graph Visualization

0 commit comments

Comments
 (0)