farn Documentation

Contents:

• farn
  • Installation
  • Usage Example
  • File Format
  • Development Setup
    • 1. Install uv
    • 2. Install Python
    • 3. Clone the repository
    • 4. Install dependencies
    • 5. (Optional) Install CUDA support
    • 6. (Optional) Activate the virtual environment
    • 7. Install pre-commit hooks
    • 8. Test that the installation works
  • Meta
  • Contributing
• ospx
  • Installation
  • Usage Example
  • File Format
  • Development Setup
    • 1. Install uv
    • 2. Install Python
    • 3. Clone the repository
    • 4. Install dependencies
    • 5. (Optional) Install CUDA support
    • 6. (Optional) Activate the virtual environment
    • 7. Install pre-commit hooks
    • 8. Test that the installation works
  • Meta
  • Contributing
• dictIO
  • Installation
  • Usage Example
  • File Format
  • Development Setup
    • 1. Install uv
    • 2. Install Python
    • 3. Clone the repository
    • 4. Install dependencies
    • 5. (Optional) Activate the virtual environment
    • 6. Install pre-commit hooks
    • 7. Test that the installation works
  • Meta
  • Contributing
• Changelogs
  • farn
    • Unreleased
    • [0.4.0] - 2024-11-11
      • Breaking changes
      • Changed
      • Solved
      • Added
      • GitHub workflows
      • Dependencies
    • 0.3.7 - 2024-05-22
      • Dependencies
      • Changed
      • Added
    • 0.3.6 - 2024-02-21
      • Added
      • Removed
      • Changed
      • Dependencies
    • 0.3.5 - 2024-01-09
      • Changed
      • Dependencies
    • 0.3.4 - 2023-09-25
      • Dependencies
    • 0.3.3 - 2023-06-22
      • Changed
      • Dependencies
    • 0.3.2 - 2023-05-04
      • Changed
    • 0.3.1 - 2023-01-11
      • Changed
      • Dependencies
    • 0.3.0 - 2023-01-09
      • Breaking Change
      • Added
    • 0.2.7 - 2023-01-04
      • Changed
      • Added
      • Dependencies
    • 0.2.6 - 2022-12-12
      • Dependencies
    • 0.2.5 - 2022-12-12
      • Changed
      • Added
      • Dependencies
    • 0.2.4 - 2022-12-01
      • Changed
      • Added
    • 0.2.3 - 2022-11-08
      • Changed
    • 0.2.2 - 2022-10-05
      • Changed
    • 0.2.1 - 2022-10-01
      • Changed
    • 0.2.0 - 2022-09-28
      • Changed
    • 0.1.2 - 2022-08-19
      • Changed
      • Added
      • Fixed
    • 0.1.1 - 2022-05-30
      • Changed
    • 0.1.0 - 2022-05-28
      • Changed
    • 0.0.22 - 2022-05-09
    • 0.0.17 - 2022-02-14
      • Added
  • ospx
    • Unreleased
    • [0.3.0] - 2024-11-11
      • Breaking changes
      • Changed
      • Solved
      • Added
      • GitHub workflows
      • Dependencies
    • 0.2.14 - 2024-05-22
      • Dependencies
      • Changed
    • 0.2.13 - 2024-02-21
      • Added
      • Removed
      • Changed
      • Dependencies
    • 0.2.12 - 2024-01-09
      • Dependencies
    • 0.2.11 - 2023-09-25
      • Dependencies
    • 0.2.10 - 2023-06-22
      • Changed
      • Dependencies
    • 0.2.9 - 2023-05-04
      • Changed
    • 0.2.8 - 2023-01-11
      • Changed
      • Dependencies
    • 0.2.7 - 2023-01-04
      • Changed
      • Added
      • Dependencies
    • 0.2.6 - 2022-12-12
      • Changed
      • Added
      • Dependencies
    • 0.2.5 - 2022-12-01
      • Changed
      • Added
    • 0.2.4 - 2022-11-08
      • Changed
      • Added
      • Solved
    • 0.2.3 - 2022-10-05
      • Solved
    • 0.2.2 - 2022-10-05
      • Solved
    • 0.2.1 - 2022-10-01
      • Changed
    • 0.2.0 - 2022-09-28
      • Solved
      • Changed
      • Added
    • 0.1.2 - 2022-08-19
      • Changed
    • 0.1.1 - 2022-05-30
      • Changed
      • Fixed
    • 0.1.0 - 2022-05-28
      • Changed
    • 0.0.22 - 2022-05-09
    • 0.0.17 - 2022-02-14
      • Added
  • dictIO
    • Unreleased
    • 0.4.0 - 2024-11-11
      • Breaking changes
      • Changed
      • Solved
      • Added
      • GitHub workflows
      • Dependencies
    • 0.3.4 - 2024-05-22
      • Dependencies
      • Changed
    • 0.3.3 - 2024-02-21
      • Hotfix
    • 0.3.2 - 2024-02-21
      • Added
      • Removed
      • Changed
      • Dependencies
    • 0.3.1 - 2024-01-09
      • Solved
    • 0.3.0 - 2024-01-08
      • Changed
      • Dependencies
    • 0.2.9 - 2023-09-20
      • Dependencies
    • 0.2.8 - 2023-06-22
      • Changed
      • Dependencies
    • 0.2.7 - 2023-05-04
      • Changed
    • 0.2.6 - 2023-01-11
      • Changed
    • 0.2.5 - 2023-01-04
      • Changed
      • Added
    • 0.2.4 - 2022-12-12
      • Changed
      • Added
    • 0.2.3 - 2022-12-01
      • Changed
      • Added
    • 0.2.2 - 2022-11-08
      • Added
    • 0.2.1 - 2022-10-13
      • Solved
    • 0.2.0 - 2022-09-29
      • Added
      • Changed
      • Removed
    • 0.1.2 - 2022-09-27
      • Solved
    • 0.1.1 - 2022-08-19
      • Added
    • 0.1.0 - 2022-05-28
      • Changed
    • 0.0.22 - 2022-05-09
    • 0.0.17 - 2022-02-14
      • Added
• LICENSE
• API Documentation
  • farn package
    • Subpackages
      • farn.core
        • farn.core.case
        • farn.core.parameter
      • farn.run
        • farn.run.batchProcess
        • farn.run.cli
        • farn.run.subProcess
        • farn.run.utils
      • farn.sampling
        • farn.sampling.sampling
      • farn.utils
        • farn.utils.logging
        • farn.utils.os
    • Modules
      • farn.farn
        • create_case_folders()
        • create_case_list_files()
        • create_cases()
        • create_param_dict_files()
        • create_samples()
        • execute_command_set()
        • run_farn()
  • ospx package
    • Subpackages
      • ospx.fmi
        • ospx.fmi.experiment
        • ospx.fmi.fmu
        • ospx.fmi.unit
        • ospx.fmi.variable
      • ospx.watch
        • ospx.watch.cli
        • ospx.watch.watchCosim
      • ospx.utils
        • ospx.utils.dateTime
        • ospx.utils.dict
        • ospx.utils.logging
        • ospx.utils.plotting
        • ospx.utils.zip
    • Modules
      • ospx.component
        • Component
        • RemoteAccess
      • ospx.connection
        • Connection
        • Endpoint
      • ospx.connector
        • Connector
      • ospx.graph
        • Graph
      • ospx.importer
        • OspSystemStructureImporter
      • ospx.ospCaseBuilder
        • OspCaseBuilder
      • ospx.ospSimulationCase
        • OspSimulationCase
      • ospx.simulation
        • Simulation
      • ospx.system
        • System
  • dictIO package
    • Subpackages
      • dictIO.utils
        • dictIO.utils.counter
        • dictIO.utils.dict
        • dictIO.utils.logging
        • dictIO.utils.path
        • dictIO.utils.strings
    • Modules
      • dictIO.dict
        • SDict
      • dictIO.dict_parser
        • DictParser
      • dictIO.dict_reader
        • DictReader
      • dictIO.dict_writer
        • DictWriter
        • create_target_file_name()
      • dictIO.formatter
        • FoamFormatter
        • Formatter
        • JsonFormatter
        • NativeFormatter
        • XmlFormatter
      • dictIO.parser
        • FoamParser
        • JsonParser
        • NativeParser
        • Parser
        • XmlParser
      • dictIO.types
      • dictIO.cpp_dict
        • CppDict
  • Example of farn API usage
    • Case
    • Cases
    • Create case folder(s)
    • Create paramDict file in case folder(s)
    • Prepare OSP simulation case(s)
    • Run OSP simulation case(s)
    • Execute post-processing (optional)
    • Read results
• CLI Documentation
  • farn
    • farn - CLI interface
      • farn positional arguments
      • farn options
    • batchProcess - CLI interface
      • batchProcess positional arguments
      • batchProcess options
  • ospx
    • ospCaseBuilder - CLI interface
      • ospCaseBuilder positional arguments
      • ospCaseBuilder options
    • importSystemStructure - CLI interface
      • importSystemStructure positional arguments
      • importSystemStructure options
    • watchCosim - CLI interface
      • watchCosim positional arguments
      • watchCosim options
  • dictIO
• File Formats
  • farn
    • farnDict
      • Description
      • Elements
      • Example
      • Filtering of Cases
        • Structure of the _condition Element
        • Filter Expression
        • Action
        • Case Attributes
        • Effect of farn options on Filtering
        • Erraneous filter expressions
  • ospx
    • caseDict
      • Description
      • Elements
      • Example
    • watchDict
      • Description
      • Elements
      • Related files
      • Example
  • dictIO
    • dict
      • Description
      • Structure
      • Header
      • #include Directive(s)
      • Element Types
      • Examples
        • booleans
        • numbers
        • nones
        • strings
        • dicts
        • lists
      • References and Expressions
      • Nesting
      • The dict-in-a-list Pitfall

Indices and tables

• Index

• Module Index

• Search Page