Skip to content
Snippets Groups Projects

Docstrings

Merged s214735 requested to merge docstrings into main
48 files
+ 438
344
Compare changes
  • Side-by-side
  • Inline

Files

+ 4
12
@@ -11,6 +11,7 @@ This offers quick interactions, making it ideal for tasks that require efficienc
## Graphical User Interfaces
The command line interface allows you to run graphical user interfaces directly from the terminal.
### `qim3d gui`
!!! quote "Reference"
@@ -38,7 +39,7 @@ This offers quick interactions, making it ideal for tasks that require efficienc
!!! Example
Here's an example of how to open the [Data Explorer](gui.md#data_explorer)
Here's an example of how to open the [Data Explorer](gui.md#qim3d.gui.data_explorer)
``` title="Command"
qim3d gui --data-explorer
@@ -85,16 +86,6 @@ This offers quick interactions, making it ideal for tasks that require efficienc
## Data visualization
The command line interface also allows you to easily visualize data.
@@ -190,7 +181,8 @@ Or an specific path for destination can be used. We can also choose to not open
This writes to disk the `my_plot.html` file.
## File preview
Command line interface, which allows users to preview 3D structers or 2D images directly in command line.
File previewing can also be done directly from the command line interface to preview 3D structure or 2D images.
### `qim3d preview`
| Arguments | Description |
| --------- | ----------- |
Loading