# Project
`iota.session.Project()`
**Description** Iota project object.
**Methods**
* [`exists_scenario`](/iota-python-api/iota/project.md#exists_scenario)
* [`get_scenario`](/iota-python-api/iota/project.md#get_scenario)
* [`get_scenarios`](/iota-python-api/iota/project.md#get_scenarios)
* [`add_scenario`](/iota-python-api/iota/project.md#add_scenario)
* [`get_dataset`](/iota-python-api/iota/project.md#get_dataset)
* [`get_datasets`](/iota-python-api/iota/project.md#get_datasets)
* [`add_dataset`](/iota-python-api/iota/project.md#add_dataset)
* [`import_dataset`](/iota-python-api/iota/project.md#import_dataset)
* [`exists_graph`](/iota-python-api/iota/project.md#exists_graph)
* [`get_graph`](/iota-python-api/iota/project.md#get_graph)
* [`get_graphs`](/iota-python-api/iota/project.md#get_graphs)
* [`add_graph`](/iota-python-api/iota/project.md#add_graph)
* [`add_file`](/iota-python-api/iota/project.md#add_file)
* [`get_file`](/iota-python-api/iota/project.md#get_file)
* [`get_files`](/iota-python-api/iota/project.md#get_files)
* [`get_mesh`](/iota-python-api/iota/project.md#get_mesh)
* [`get_meshes`](/iota-python-api/iota/project.md#get_meshes)
* [`add_mesh`](/iota-python-api/iota/project.md#add_mesh)
* [`get_script`](/iota-python-api/iota/project.md#get_script)
* [`get_scripts`](/iota-python-api/iota/project.md#get_scripts)
* [`add_script`](/iota-python-api/iota/project.md#add_script)
* [`add_video`](/iota-python-api/iota/project.md#add_video)
* [`add_screenshot`](/iota-python-api/iota/project.md#add_screenshot)
* [`run_batch_processing`](/iota-python-api/iota/project.md#run_batch_processing)
* [`delete`](/iota-python-api/iota/project.md#delete)
**Variables**
* `name` (str) project name
* `description` (str) project description
* `id` (int) project Id
## Methods
### [exists\_scenario(name)](/iota-python-api/iota/project.md#exists_scenario)
*Return a scenario belonging to a specified project, by name*
**Arguments**
* `name`: (str) scenario name
**Example**
```python
if project.exists_scenario('my_scenario'):
print('scenario exist')
```
### [get\_scenario(name)](/iota-python-api/iota/project.md#get_scenario)
*Return a scenario belonging to a specified project, by name*
**Arguments**
* `name`: (str) scenario name
**Example**
```python
scenario = project.get_scenario(name='my_scenario')
```
### [get\_scenarios()](/iota-python-api/iota/project.md#get_scenarios)
*Return the list of scenarios in the project*
**Example**
```python
for scenario in project.get_scenarios():
print('scenario: {}'.format(scenario.name))
```
### [add\_scenario(name,\[description\])](/iota-python-api/iota/project.md#add_scenario)
*Create and return a scenario, described by name and optional description and tags*
**Arguments**
* `name`: (str) scenario name
* `description`: (str) scenario description (default: None)
**Example**
```python
new_scenario = project.add_scenario(
name = 'scenario 01',
description = 'simulation mixing analysis with speeed = 30 RPM'
)
```
### [get\_dataset(name,\[data\_format\])](/iota-python-api/iota/project.md#get_dataset)
*Return a dataset record specified by name*
**Arguments**
* `name`: (str) scenario name
* `data_format`: (str) data format of the dataset to be loaded. The project can have more than one dataset with the same name if data\_format is different. (default: **None**)
**Example**
```python
dataset = project.get_dataset(
name = 'mixing_rpm_30',
data_format = 'PADEM'
)
```
### [get\_datasets()](/iota-python-api/iota/project.md#get_datasets)
*Return the list of dataset records in the project*
**Example**
```python
print('List of datasets in the project')
for dataset in project.get_datasets():
print('dataset: {} (format: {})'.format(dataset.name,dataset.data_format))
```
### [add\_dataset(name, data\_format, file, \[description\], \[scenario\])](/iota-python-api/iota/project.md#add_dataset)
*Add a Iota Dataset file to the project* *data\_format must be one of **PADEM** or **PACG***
**Arguments**
* `name`: (str) dataset name
* `data_format`: (str) format of the dataset
* `file`: (str) dataset filepath
* `description`: (str) dataset description (default: **None**)
* `scenario`: (str) add dataset to a specific scenario (default: **None**)
**Example**
```python
project.add_dataset(
name = 'mixing_rpm_32',
data_format = 'PADEM',
file = '/path/to/my/dataset/mixing_rpm_32.meta',
description = 'mixing analysis with drum speed of 32 RPM'
)
```
### [import\_dataset(file,\[name\],\[data\_format\],\[include\_graphs\],\[description\],\[scenario\])](/iota-python-api/iota/project.md#import_dataset)
*Import external Dataset to the project* *data\_format must be one of the accepted formats: \[**EDEM 2017**]*
**Arguments**
* `file`: (str) dataset filepath
* `name`: (str) dataset name. If not defined, used the basename of the filepath (Default: **None**)
* `data_format`: (str) format of the dataset
* `include_graphs`: (bool) import any graph available in the dataset to the project
* `description`: (str) dataset description (Default: **None**)
* `scenario`: (str) add dataset to a specific scenario (default: **None**)
**Example**
```python
project.import_dataset(
file = '/path/to/my/edem/dataset/simulation.dem',
name = 'mixing_rpm_34',
data_format = 'EDEM 2017',
include_graphs = True,
description = 'mixing analysis with drum speed of 34 RPM'
)
```
### [exists\_graph(name,\[tags\])](/iota-python-api/iota/project.md#exists_graph)
*Return True if graph exists, specified by name (and tags)*
**Arguments**
* `name`: (str) graph name
* `tags`: (dict) tags dictionary
**Example**
```python
exists_graph = project.exists_graph(
name = 'Reaction Force',
tags = {
'dataset': 'mixing_rpm_34'
}
)
if exists_graph:
print('graph exist!')
```
### [get\_graph(name,\[tags\])](/iota-python-api/iota/project.md#get_graph)
*Return a graph, specified by name (and tags)*
**Arguments**
* `name`: (str) graph name
* `tags`: (dict) tags dictionary
**Example**
```python
graph = project.get_graph(
name = 'Reaction Force',
tags = {
'dataset': 'mixing_rpm_34'
}
)
```
### [get\_graphs()](/iota-python-api/iota/project.md#get_graphs)
*Return the list of graphs in the project*
**Example**
```python
print('List of graphs:')
for graph in project.get_graphs():
print('Graph: {}'.format(graph.name))
```
### [add\_graph(name,\[title\],\[xdata\],\[ydata\],\[legend\],\[xtitle\],\[ytitle\],\[csvfile\],\[overwrite\],\[description\],\[tags\],\[scenario\])](/iota-python-api/iota/project.md#add_graph)
*Add a new graph to the project. The graph can be defined in a **csv file** or by defining all the components (data, titles, etc)*
**Arguments**
* `name`: (str) graph name
* `title`: (str) graph title
* `filepath`: (str) optional file path for new graph file (Default: **None**)
* `xdata`: (iota.ArrayFloat) array of data representing the values of axis X
* `ydata`: (list\[iota.ArrayFloat]) list of arrays representing the data series
* `legend`: (list\[str]) list of names for the data series
* `xtitle`: (str) title of the axis X
* `ytitle`: (str) title of the axis Y
* `csvfile`: (str) csv file containing the graph data. If this is defined, none of the previous variables are considered
* `description`: (str) graph description
* `tags`: (dict) tags dictionary
* `overwrite`: (bool) overwrite graph file if already exists
**Example**
```python
x_values = iota.ArrayFloat([0,1,2,3,4,5,6])
average_force = iota.ArrayFloat(len(x_values),10.0)
graph = project.add_graph(
name = 'Average Force',
title = 'Average Force',
xtitle = 'Step',
xdata = x_values,
ytitle = 'Force',
legend = ['Force'],
ydata = [average_force],
tags = {
'dataset': 'mixing_rpm_34'
},
overwrite = True
)
graph2 = project.add_graph(
name = 'Average Torque',
csvfile = '/path/to/my/graph/torque.csv',
tags = {
'dataset': 'mixing_rpm_34'
}
)
```
### [get\_mesh()](/iota-python-api/iota/project.md#get_mesh)
*Return a mesh specified by a name*
**Arguments**
* `name`: (str) mesh name
**Example**
```python
mesh_record = project.get_mesh(
name = 'mixing_drum_v02'
)
```
### [get\_meshes()](/iota-python-api/iota/project.md#get_meshes)
*Return th elist of meshes in the project*
**Example**
```python
print('List of meshes:')
for mesh in project.get_meshes():
print(' mesh: {}'.format(mesh.name))
```
### [add\_mesh(file, \[description\])](/iota-python-api/iota/project.md#add_mesh)
*Add a mesh by filepath to the project*
**Arguments**
* `file`: (str) mesh filepath
* `description`: (str) mesh description
**Example**
```python
project.add_mesh(
file = '/path/to/my/mesh/mixing_drum_v2.stl',
description = 'Mixing drum with inclinantion of 30 degrees'
)
```
### [get\_file(name)](/iota-python-api/iota/project.md#get_file)
*Return a file, specified by name*
**Arguments**
* `name`: (str) file name
**Example**
```python
file = project.get_file(
name = 'list of values test 2'
)
```
### [get\_files()](/iota-python-api/iota/project.md#get_files)
*Return the list of files in the project*
**Example**
```python
print('List of files:')
for file in project.get_files():
print(' file: {}'.format(file.name))
```
### [add\_file(name, filepath, \[description\])](/iota-python-api/iota/project.md#add_file)
*Create and return a file, describe by name, filepath and optional description*
**Arguments**
* `name`: (str) scenario name
* `filepath`: (str) file path
* `description`: (str) file description (Default: **None**)
**Example**
```python
project.add_file(
name = 'my text file',
filepath= '/path/to/my/file/text.txt',
description='this file contains the summary of parameters used for the simulations'
)
```
### [get\_script(name)](/iota-python-api/iota/project.md#get_script)
*Return a script spcified by a name*
**Arguments**
* `name`: (str) script name
**Example**
```python
script_file = project.get_script(
name = 'calculate mixing index'
)
```
### [get\_scripts()](/iota-python-api/iota/project.md#get_scripts)
*Return the list of scripts in the project*
**Example**
```python
print('List of scripts:')
for script in project.get_scripts():
print(' script: {}'.format(script.name))
```
### [add\_script()](/iota-python-api/iota/project.md#add_script)
*Add a script (python file) to the project*
**Arguments**
* `name`: (str) script name
* `filepath`: (str) script file path
* `description`: (str) script description (Default: **None**)
**Example**
```python
project.add_script(
name = 'calculate mixing index',
filepath = '/path/to/my/scripts/calculate_mixing_index.py',
description = 'This script calculate the Lacey mixing index using binning'
)
```
### [add\_video(file,name,\[description\],\[tags\],\[thumbnail\])](/iota-python-api/iota/project.md#add_video)
*Add a video file to the project*
**Arguments**
* `file`: (str) video file path
* `name`: (str) video name
* `description`: (str) video description (Default: **None**)
* `tags`: (dict) tags dictionary (Default: **None**)
* `thumbnail`: (str) image file to be used as a thumbnail (Default: **None**)
**Example**
```python
project.add_video(
file = '/path/to/my/videos/mixer_rpm_32_velocity_X.mp4',
name = 'Mixer at 32 RPM',
description = 'This video shows the velocity profile in X direction for the case with drum speed at 32 RPM',
tags = {
'dataset': 'mixer_rpm_32',
'result': 'Velocity (X)'
}
)
```
### [add\_screenshot(file,name,\[description\],\[tags\])](/iota-python-api/iota/project.md#add_screenshot)
*Add image file to the project*
**Arguments**
* `file`: (str) screenshot file path
* `name`: (str) screenshot name
* `description`: (str) screenshot description (Default: **None**)
* `tags`: (dict) tags dictionary (Default: **None**)
**Example**
```python
project.add_video(
file = '/path/to/my/images/mixer_rpm_32_velocity-Y_time3.42.png',
name = 'Mixer at 32 RPM',
description = 'Velocity profile in Y direction for the case with drum speed at 32 RPM. Time = 3.42s',
tags = {
'dataset': 'mixer_rpm_32',
'result': 'Velocity (Y)',
'timestep': '3.42'
}
)
```
### [delete()](/iota-python-api/iota/project.md#delete)
*Delete project from the database (and disk if applicable)*
**Example**
```python
name = project.name
project.delete()
if not session.exist_project(name):
print('project removed')
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://particle-analytics-1.gitbook.io/iota-python-api/iota/project.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.