Main Content

modelfinder

Search and open examples, models, and projects

Since R2022a

    Description

    modelfinder(searchTerm) displays a numbered list of examples, models, and projects available in the databases that match the search term and prompts you to enter a corresponding number to open any search result. Other options in the prompt include q to quit and m to see more results. Search results that appear indented and prefixed with > are Simulink® models that are a part of an example or project.

    Model Finder supports keyword-based searches and natural language queries. When you enter a search term, Model Finder matches your search term with the metadata of the examples and models indexed in the databases selected for searching. The metadata includes model names, example names, model paths, description, annotation, block names, block types, MathWorks® products, and referenced files.

    By default, modelfinder searches the MathWorks Examples database. For information on setting search databases with Model Finder, see modelfinder.setSearchDatabase.

    example

    modelfinder(___,Name=Value) specifies search options using one or more name-value arguments in addition to the input argument in the previous syntax. For example, set filters to the name of a ModelFinderFilter object to narrow down searches based on parameters such as model locations, block types, or MathWorks products.

    example

    Examples

    collapse all

    Search for examples and models in the search databases using the search term autosar.

    modelfinder("autosar")

    modelfinder matches the search term with the metadata indexed in the MathWorks Examples database and displays a numbered list of examples with their supporting models prefixed with > and indented:

       1. Generate AUTOSAR C Code and XML Descriptions
            > autosar_swc
       2. Create and Configure AUTOSAR Software Component
       3.   > autosar_swc
       4. Modeling Patterns for AUTOSAR Runnables
       5.   > autosar_swc_fcncalls
       6.   > autosar_swc_slfcns
       7. Find Model States in Simulink Mappings
            > autosar_swc
       8. Import AUTOSAR Package into Component Model
            > autosar_swc
       9. Configure Subcomponent Data for AUTOSAR Calibration and Measurement
      10.   > autosar_component
      11.   > autosar_subcomponent
      12. Design and Simulate AUTOSAR Components and Generate Code
      13.   > autosar_composition
      14.   > autosar_swc_actuator
      15.   > autosar_swc_controller
      16.   > autosar_swc_monitor
      17.   > autosar_swc_pedal_sensor
      18.   > autosar_swc_throttle_sensor
      19.   > autosar_system
      20. Configure and Simulate AUTOSAR Function Inhibition Service Calls
      21.   > autosar_bsw_fim
      22.   > autosar_bsw_fimmonitor
      23.   > autosar_bsw_fimoperationcycle
      24.   > autosar_bsw_fimsensor1
      25.   > autosar_bsw_fimsensor2
    
    Showing 1-25 of 223 matches. Enter (m) for more results.
    
    Enter the example number you want to open (choose number)
    OR see more results (m) OR quit (q)
    Selection: 
     

    Running the same query can produce different results depending on the MathWorks Examples database version.

    Search for examples and models in the search databases using the search term solar panel models in simulink.

    modelfinder("solar panel models in simulink")

    modelfinder searches the MathWorks Examples database using natural language query and displays a numbered list of examples with their supporting models indented prefixed with > and indented:

       1. Photovoltaic Thermal (PV/T) Hybrid Solar Panel
            > sscv_hybrid_solar_panel
       2. Solar Panel Parameterization Validation
            > SolarPanelValidation
       3. Stand-Alone Solar PV AC Power System with Battery Backup
            > SolarPVACWithBattery
       4. Stand-Alone Solar PV DC Power System with Battery Backup
            > SolarPVDCWithBattery
       5. Solar PV System with MPPT Using Boost Converter
            > SolarPVMPPTBoost
       6. Three-Phase Grid-Connected Solar Photovoltaic System
            > GridConnectedPV
       7. DC Fast Charging Station for Electric Vehicles with Solar Cogeneration
            > DCFastChargingStation
       8. Microgrid Planned Islanding from Main Grid
            > MicrogridPlannedIslanding
       9. Microgrid Resynchronization with Main Grid
            > MicrogridResynchronization
      10. Peak Shaving with Battery Energy Storage System
            > sscv_peak_shaving
      11. Single-Phase Grid-Connected Solar Photovoltaic System
            > SinglePhaseGridSolarPV
      12. Using the Worm and Gear Constraint Block - Solar Tracker
            > WormAndGearConstraint
      13. Photovoltaic Generator
            > PhotovoltaicGenerator
      14. Mars Helicopter System-Level Design
            > MarsHelicopterDesign
      15. Mars Helicopter System-Level Design
            > marsHelicopterSystem
      16. Solar Power Inverter
            > SolarPowerInverter
      17. Solar Cell Power Curve
            > SolarCellPowerCurve
      18. Analysis of Solar Photovoltaic System Shading
            > PhotovoltaicShading
      19. Simplified Model of a Small Scale Micro-Grid
            > SmallScaleMicroGrid
    Enter the example number you want to open (choose number) OR quit (q) :

    Running the same query may produce different results depending on the database version.

    Search for examples and models using a search term, and narrow down the search results by specifying block types and MathWorks product names.

    Create a ModelFinderFilter object with specific Simulink blocks and MathWorks product names.

    blockList = ["ConstellationDiagram",...
                 "Rectangular QAM Modulator Baseband"];
    productList = ["Communications","5G","Wireless","Satellite"];
    mfFilter = modelfinder.searchFilter(block=blockList,product=productList)
       mfFilter = 
    
      ModelFinderFilter with properties:
    
            match: [0×0 string]
          product: ["Communications"    "5G"    "Wireless"    "Satellite"]
         location: [0×0 string]
            block: ["ConstellationDiagram"    "Rectangular QAM Modulator Baseband"]
        reference: [0×0 string]

    Search for models using a search term and a filter object.

    modelfinder("modulation",filters=mfFilter)

    modelfinder matches the search term with all the metadata of the examples and models indexed with the MathWorks Examples database and narrows down the results using the specified blocks and product names:

     1. Add Saleh Model of Power Amplifier to 16-QAM Signal in Simulink
            > cm_mnl_saleh_16qam
      2. Apply Phase/Frequency Offset to QAM Modulated Signal
            > cm_poff_foff_imp_qam
      3. Effect of Nonlinear Amplifier on 16-QAM Modulation
            > amp_qam16
      4. Passband Modulation
            > commpassbandmod
      5. Add RF Impairments to DQPSK Signal
            > slex_rcvrimpairments_dqpsk
      6. cdma2000 Physical Layer in Simulink
            > cdma2000SimulinkExample
      7. ATSC Digital Television
            > commatsc
      8. Apply Complex Phase Shift to QPSK Signal
            > cm_complex_phase_shift_qpsk
      9. Defense Communications: US MIL-STD-188-110A Receiver
            > commmilstd188110a
      10. Digital Video Broadcasting - Cable (DVB-C) in Simulink
      11.   > commdvbc
      12.   > commdvbc_fixpt
      13. Measure EVM and MER Using Simulink
            > doc_mer_and_evm
      14. Examine 256-QAM Using Simulink
            > cm_commphasenoise
      15. Executable Specification for System Design
      16.   > rfb_receiver_0
      17.   > rfb_receiver_1
      18. Manchester Receiver Using Communications Toolbox
            > manchestermodelcommblks
      19. Plot M-PAM Constellation in Simulink
            > doc_mpam_mod
      20. Plot Noisy 16-APSK Constellation
            > slex_16apsk_mod
    
    Showing 1-20 of 24 matches. Enter (m) for more results.
    
    Enter the example number you want to open (choose number) 
    OR see more results (m) OR quit (q) 
    Selection:

    Modify the filter object to match the search term with only the names of examples and models indexed in the database.

    mfFilter.match = "name"
       mfFilter = 
    
      ModelFinderFilter with properties:
    
            match: "name"
          product: ["Communications"    "5G"    "Wireless"    "Satellite"]
         location: [0×0 string]
            block: ["ConstellationDiagram"    "Rectangular QAM Modulator Baseband"]
        reference: [0×0 string]

    Search for models using a search term and the modified filter object.

    modelfinder("modulation",filters=mfFilter)

    modelfinder matches the search term with only the names of the examples and models indexed with the MathWorks Examples database and narrows down the results by using the specified blocks and product names:

       1. Effect of Nonlinear Amplifier on 16-QAM Modulation
            > amp_qam16
       2. Passband Modulation
            > commpassbandmod
    Enter the example number you want to open (choose number) OR quit (q):

    Running the same query may produce different results depending on the database version.

    When you use the modelfinder function to search, the results are displayed by default as a numbered list of examples with their supporting models indented and prefixed with >. To view the search results as a list of models, set the name-value argument view to "Models".

    modelfinder("autosar",view="Models")
       1. autosar_swc
       2. autosar_swc_fcncalls
       3. autosar_swc_slfcns
       4. autosar_swc
       5. autosar_component
       6. autosar_subcomponent
       7. autosar_composition
       8. autosar_swc_actuator
       9. autosar_swc_controller
      10. autosar_swc_monitor
      11. autosar_swc_pedal_sensor
      12. autosar_swc_throttle_sensor
      13. autosar_system
      14. autosar_bsw_fim
      15. autosar_bsw_fimmonitor
      16. autosar_bsw_fimoperationcycle
      17. autosar_bsw_fimsensor1
      18. autosar_bsw_fimsensor2
      19. autosar_swc_counter
      20. autosar_bsw_inject
      21. autosar_bsw_inject_test
      22. autosar_bsw_override_test
      23. autosar_bsw_monitor
      24. autosar_bsw_presim
      25. autosar_bsw_sensor1
      26. autosar_bsw_sensor2
      27. autosar_bsw_simulation
    
    Showing 1-27 of 169 matches. Enter (m) for more results.
    
    Enter the example number you want to open (choose number) 
    OR see more results (m) OR quit (q) 
    Selection:

    Running the same query may produce different results depending on the database version.

    Input Arguments

    collapse all

    Search string to find examples, models, and projects in selected databases, specified as a string scalar or character vector. Searches are case-insensitive and disregards special characters. Model Finder matches the search string with the metadata of the examples and models indexed in the databases selected for searching. The metadata includes model names, example names, model paths, description, annotation, block names, block types, MathWorks products, and referenced files.

    Example: "autosar"

    Example: "pmsm models using discrete pulse generator"

    Data Types: string | char

    Name-Value Arguments

    collapse all

    Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

    Example: modelfinder("modulation",filters=mfFilter,verbose="on") searches for models containing the search term modulation and narrows down the search results by using a ModelFinderFilter object mfFilter. With the verbose name-value argument set to "on", it also displays additional information related to the search results.

    Filters used to narrow down the search results based on MathWorks product names, model locations, block types, or external referenced files, specified as a ModelFinderFilter object. To create a ModelFinderFilter object, see ModelFinderFilter.

    Example: filters=mfFilter

    Option to customize the search results layout, specified as one of these values:

    • "Categorized" — Display search results as a numbered list of examples and models. Simulink models that are a part of an example or project appear indented and prefixed with >.

    • "Models" — Display search results as a numbered list of models. The search results include independent models and models that are referenced by examples and projects.

    Example: view="Models"

    Data Types: string | char

    Option to display additional information related to the search results, specified as one of these values:

    • "off" — Display only the names of the matched examples, models, and projects.

    • "on" — Display the names of the matched examples, models, and projects with these additional details:

      • Source — Example name.

      • Matched in — Metadata of examples and models that matches the search terms. The metadata includes model names, example names, model paths, description, annotation, block names, block types, MathWorks products, and referenced files.

      • Matched text — Matching search terms.

    Example: verbose="on"

    Number of search results displayed per page, specified as a numeric scalar.

    Example: resultsPerPage=5

    Data Types: double

    Alternatives

    You can search databases by using the Model Finder user interface. For more information, see Model Finder.

    Version History

    Introduced in R2022a

    expand all