IotaSuite User Manual
  • Summary
  • Dashboard
    • Creating a Project
    • Editing a Project
    • Deleting a Project
    • Loading a Project
    • Unloading a Project
  • Project
    • Datasets
      • Importing a Dataset
      • Editing a Dataset
      • Deleting a Dataset
      • Visualising a Dataset
    • Screenshots
      • Importing a Screenshot
      • Editing a Screenshot
      • Deleting a Screenshot
      • Exporting a Screenshot
    • Graphs
      • Importing a Graph
      • Editing a Graph
      • Deleting a Graph
      • Exporting a Graph
    • Meshes
      • Importing a Mesh
      • Editing a Mesh
      • Deleting a Mesh
    • Videos
      • Editing a Video
      • Deleting a Video
      • Exporting a Video
    • Files
      • Importing a File
      • Editing a File
      • Deleting a File
    • Scripts
      • Importing a Script
      • Editing a Script
      • Deleting a Script
    • List of Scenarios
      • Creating a New Scenario
      • Loading a Scenario
      • Deleting a Scenario
      • Cloning a Scenario
  • Scenario
    • Creating a New scenario
    • Loading a Scenario
    • Editing a Scenario
    • Deleting a Scenario
    • Cloning a Scenario
  • Pre
    • Cretaing a Mesh of a Simple Geometry
      • Circle
      • Rectangle
      • Cuboid
      • Cylinder
    • Loading a Mesh
    • Importing a Mesh from a File
    • Filling holes of a Surface Mesh
    • Generating / Re-meshing a volume mesh
    • Remeshing a surface mesh
    • Creating Cut-Planes
  • Post
    • Visualising Results
    • Animating Results
    • Taking a Screenshot
    • Recording an Animation
    • Setting a View
      • Exporting and Importing a View
    • Post-processing Tools
      • Generating Cut Planes with Results
      • Generating a Line Variation Graph
      • Generating a Point Evolution Graph
      • Generating a Result Integral Graph
      • Generating a Result Statistics Graph
  • Graph
    • Customizing the Style of a Graph Traces
    • Customizing Graph Axes Settings
    • Exporting a Graph as an Image
  • Coarse-graining
    • Introduction
    • Coarse-granining module
      • Loading a Mesh
      • Input
        • Input DEM data
          • EDEM 2017+
          • LIGGGHTS-DUMP
          • LIGGGHTS-VTK
          • P4X
        • Pre-Filters
          • Overwrite Groups by Size
          • Filter Group ID
          • Filter by Bounding Box
          • Overwrite Velocity
          • Overwrite Groups
      • Averaging
        • Temporal Averaging
        • Spatial Averaging
          • Function
          • Width and Cutoff Factor
          • Gradients
          • Spatial Integral
        • Advanced
          • Particle Group Concentration
          • Surface/Wall Analysis
          • Residence Time
      • Output
        • Scale Results
        • Create DEM Dataset
        • Coarse Graining Output
        • Output Cylindrical Coordinates
        • Post-Analysis
          • Mixing
          • User-defined Scripts
  • Using Iota with EDEM
  • Using Iota with LIGGGHTS
    • LIGGGHTS-DUMP
    • LIGGGHTS-VTK
  • Using Iota with ANSYS-Fluent
  • Tutorials
    • Backhoe Tutorial EDEM 2017+
    • Paddle Mixer Tutorial EDEM 2017+
  • Licensing
    • Iota-Suite End User Agreement
    • Third Party Licenses
Powered by GitBook
On this page
  • Importing a Script
  • Editing a Script
  • Deleting a Script
  • Running a Script

Was this helpful?

  1. Project

Scripts

PreviousDeleting a FileNextImporting a Script

Last updated 5 years ago

Was this helpful?

This section shows any Python scripts associated with the project/scenario. The Scripts accordion shows the following information per script (see ):

  • Name: name provided by the user to indentify the script.

  • Type: "file/script". Provided for legacy reasons (script is now a dedicated type).

  • Filename: name of the Python script (*.py) file on the hard drive.

  • Scenario: name of the scenario if the script is associated with a scenario.

  • Modfied: last date the script was modified.

Figure 15 - "Scripts" section of Iota

Users can import Python scripts into the project/scenario by clicking on the Import button located at the right corner of accordion (see ). A pop-up window will be shown so the user can enter the following fields for the file/script:

  • Name (required): a name for the script. If none is provided, the file name will be used.

  • Description (optional): a description for the script.

  • Scenario (optional): any scenario associated with the script.

  • Choose File: the button opens a file browser window that allows users to select the Python script (*.py) to be imported.

Note that the python scripts to be imported in this section must contain the function def run(scenario): defined in the .py file. See the documentation of the for a more detailed description of the functionality available from the provided by the scripting interface.

Figure 16 - Import Script window

Clicking on the Edit button launches a window where the user can rename the script.

Clicking on the Delete button launches a window prompting the user to confirm deletion.

The scripts associated with the project/scenario are available in the section of the Coarse-graining page so that users can select them to be automatically executed immediately after the coarse-graining run has completed. Also, the user can run scripts using the Iota IPython Terminal (for more details, see in the .

Post-Analysis
"Running Scripts"
Iota Python Library manual
Editing a Script
Deleting a Script
Running a Script
Iota Python Library
Figure 15
Importing a Script
Figure 15