mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
38 lines
920 B
Markdown
Vendored
38 lines
920 B
Markdown
Vendored
---
|
|
title: run
|
|
description: Learn how to effectively run a notebook from a specific location using
|
|
various parameters. This page also provides details about certain parameters such
|
|
as report parameters and the file to be loaded.
|
|
keywords:
|
|
- run notebook
|
|
- usage
|
|
- parameters
|
|
- file loading
|
|
- report parameters
|
|
- OpenBBUserData
|
|
- custom reports
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="reports /run - Reference | OpenBB Terminal Docs" />
|
|
|
|
Run a notebook from this folder: '/home/runner/OpenBBUserData/reports/custom reports'.
|
|
|
|
### Usage
|
|
|
|
```python
|
|
run -f {} [-p PARAMETERS [PARAMETERS ...]]
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| file | The file to be loaded | None | False | None |
|
|
| parameters | Report parameters with format 'name:value'. | None | True | None |
|
|
|
|
---
|