DEV Community: KeitaHoshino

[iRIC] [New Feature] How to Use Project-Specific Default Colormap Settings

KeitaHoshino — Thu, 27 Feb 2025 00:28:50 +0000

Introduction

A very useful new feature has been added!

Have you ever customized the colormap settings to your liking...

...only to find that you have to set everything again when opening a new visualization window?

This new feature solves that problem with just one button!

How to Use

Once you've adjusted the colormap settings to your preference, simply click the newly added "Set as Default" button.

After setting it as the default, any new visualization window will automatically use this colormap setting.
This is a very convenient feature, so be sure to take advantage of it!

Note:

The default setting is saved for each scalar individually.

Every time you click "Set as Default", the previous setting is overwritten. If you want to keep the old colormap settings, use the export feature.

Below is an advanced section for those who are interested.

Learn More

Where Default Settings Are Stored

The project-specific default colormap settings are stored in the project.xml file, which contains project information.

Note:

If you saved the project using "Save As Project", project.xml will be located in the corresponding folder.

If you saved the project using "Save As File(*.ipro)", extract the .ipro file to find project.xml inside.

If you open project.xml in a text editor, you will see something like this:

<?xml version="1.0" encoding="UTF-8"?>
<iRICProject version="4.1.0.6959" solverName="Nays2DH" solverVersion="1.6.4" coordinateSystem="EPSG:2454" timeFormat="elapsed|SS sec" customTimeFormat="" offsetX="0" offsetY="0" separateResult="false">
    <CgnsFileList current="Case1">
        <CgnsFileEntry filename="Case1" comment=""/>
    </CgnsFileList>
    <MeasuredDatas/>
    <CalculationResult currentStep="187">
        <Base dimension="2">
            <Zone name="iRICZone"/>
        </Base>
    </CalculationResult>
    <PostProcessors>
        <PostProcessor ref="subwindows/post2dwindow15.xml"/>
    </PostProcessors>
    <Backgrounds/>
    <DefaultColorMapSettings>
        <ColorMapSetting name="Depth(m)" transitionMode="0" valueMode="1" autoValueRange="false" minValue="0.1" maxValue="13" fillUppeer="true" fillLower="false" colorTableMinValue="0" visible="true" direction="0" barAutoWidth="false" barWidth="30" barAlign="1" title="Depth(m)" autoNumberOfLabels="true" numberOfLabels="9" labelSkipRate="1" labelFormat="%5.2f" titleFont="Times New Roman,20,-1,5,50,0,0,0,0,0,Regular" labelFont="Times New Roman,20,-1,5,50,0,0,0,0,0,Regular" titleColor="#000000" labelColor="#000000" backgroundColor="#ffffff" backgroundOpacityEnabled="true" backgroundOpacityPercent="20" showBorder="true" position="4" horizontalMarginRatio="0.1224" verticalMarginRatio="0.094" autoSize="true" width="636" height="126">
            <Item value="0" color="#f7fbff" transparent="false"/>
            <Item value="0.125" color="#deebf7" transparent="false"/>
            <Item value="0.25" color="#c6dbef" transparent="false"/>
            <Item value="0.375" color="#9ecae1" transparent="false"/>
            <Item value="0.5" color="#6baed6" transparent="false"/>
            <Item value="0.625" color="#4292c6" transparent="false"/>
            <Item value="0.75" color="#2171b5" transparent="false"/>
            <Item value="0.875" color="#08519c" transparent="false"/>
            <Item value="1" color="#08306b" transparent="false"/>
        </ColorMapSetting>
    </DefaultColorMapSettings>
    <PreProcessorWindow ref="subwindows/preprocessor.xml"/>
    <SolverConsoleWindow minimized="false" maximized="false" left="30" top="30" width="700" height="500" backgroundColor="#c8c8c8"/>
    <PostProcessorFactory>
        <WindowCount name="graph2dhybridwindow" value="1"/>
        <WindowCount name="graph2dscatteredwindow" value="6"/>
        <WindowCount name="post2dbirdeyewindow" value="2"/>
        <WindowCount name="post2dwindow" value="18"/>
        <WindowCount name="postcrosssectionwindow" value="4"/>
    </PostProcessorFactory>
</iRICProject>

How to Delete Default Colormap Settings

To remove a default colormap setting, open project.xml in a text editor and delete the corresponding scalar's settings, then save the file.

NaysDw2 ver 1.1.24020101 released

KeitaHoshino — Fri, 16 Feb 2024 02:43:17 +0000

NaysDw2 has been updated.

NaysDw2 ver 1.1.24020101 was released on February 1, 2024.

Summary of changes

Functional improvements and new features added

Added the ability to smoothly copy a grid by specifying the calculation results to be read when selecting a solver.
Advanced mode has been added, which allows you to specify any scalar from the calculation results to be read in.
A figure of the driftwood input range has been added to the Calculation Conditions dialog.

Bug Fixes

Fixed a bug that prevented reading the initial position of driftwood from text data.
Fixed a bug that polygon items were sometimes not added to the object browser when the post-processing window was opened.

Projects created with the previous version are still available.
The details of each are organized as follows.

Change in the method of specifying the read target and copying the grid

For improved convenience and implementation of advanced mode, the method of specifying read target has been changed to the same method as EvaTRiP_Pro.

Previously, you had to manually copy the grid after creating a new project and specify the path of the CGNS file to be read in the calculation conditions.

The new method is easier to understand because you can specify the read target in the dialog that iRIC displays when you create a new project, and then copy the grid as is.

In this method, the iRIC GUI reads the read target and displays the following information, so there is no need to open the read target and check it.

Solver name
Solver version
grid type
grid size
Number of results

New method of operation

When you start a new NaysDw2 project, a dialog box for selecting a CGNS file for input will appear.

Select Case1.cgn of the project you want to load from the...button.
(The image shows the result of the debugging calculation when it is specified.

Press OK and you will be asked "Do you want to import grid from the CGNS file?" and select Yes to import the grid.

Basically, you will get an error message, but it is a specification, so don't worry about it and press Yes.

You have successfully imported the grid.

If you want to change the import target later, you can do so from the CGNS file name to import flow calculation results item in the Basic Settings group of the Calculation Conditions dialog.
However, the grid will not be updated, so please import manually.

About Advanced Mode

Advanced mode is a mode that allows you to specify any scalar other than velocity and bathymetry required for calculation with NaysDw2 to be copied from the read target and output to the NaysDw2 calculation results.
The number of scalars that can be read is as follows

type of scalar	number of scalars that can be read
scalars with "time" as a dimension (e.g. flow rate)	2
real Scalar with node	5
real Scalar with cell	5
integer Scalar with cell	5

Previously, only fixed flow, elevation, and river bed fluctuation could be read, but this allows various reference information to be visualized together.

Usage

check the Enable Advanced Mode checkbox in the +Advanced Mode group in the Calculation Conditions dialog. 2.
in Specify parameters for tracking calculations, select a scalar name for velocity and depth from the pull-down list
for other optional scalars, check the Enable checkbox in each scalar and select the scalar name from the pull-down list

The flow velocity is stored separately in the CGNS file in the X-axis direction and in the Y-axis direction. Please select the correct combination with X and Y at the end of the scalar name.

When advanced mode is enabled, the velocity used to track driftwood in the Basic Settings group is disabled and the velocity specified in advanced mode is used to track the driftwood.
If you are loading a calculation with multiple velocities (e.g. Nays2D+), you can load it as a reference in addition to the velocities used in the NaysDw2 calculation. In this case, specify the velocities in the X and Y directions of the velocities you want to read as a scalar at an arbitrary grid point.

Bug fixes

Ability to read initial driftwood location from text data

Fixed a bug in the Flowwood supply conditions group setting that did not read location information from the file specified by the initial driftwood placement location information file name even if the group was set to place the driftwood in the initial state.

Polygon section of the object browser

If no driftwood existed in the grid at the time step selected in the toolbar, a polygon item was not added to the object browser when the post-processing window was opened, and the driftwood polygon was not displayed in that post-processing window even after changing to the time step where the driftwood existed. This bug has been fixed.

You can now associate ipro files with iRIC v4.

KeitaHoshino — Mon, 16 Oct 2023 08:37:10 +0000

Introduction

iRIC v4 has been released, and many users may have both v3 and v4 installed on their PCs.

Until now, even after installing iRIC v4, ipro files were not associated, and the only way to open files was from within iRIC. Additionally, for those who also have v3 installed, ipro files were associated with v3, leading to the common frustration of launching iRIC v3 when attempting to open v4 project ipro files.

We shared this concern with the iRIC developers, and they have made it possible to associate ipro files with iRIC v4!

Configuration Steps

Launch iRIC v4's Maintenance Tool.

If you're unsure about how to launch the Maintenance Tool, please refer to the article below for guidance.

https://dev.to/starfieldkt/how-to-install-iric-and-solvers-ma9

Check 'Add or remove components' and click 'Next.'

Check '*.ipro association' under iRIC GUI and click 'Next.'

Click 'Update.'

After the update is complete, click 'Finish' to close the Maintenance Tool.

The icon for ipro files has been changed to the iRIC logo, and clicking on it now launches iRIC v4!!!

[iRIC v4] Changed the specifications of the zoom in/out operation.

KeitaHoshino — Thu, 31 Aug 2023 12:54:22 +0000

In iRIC v4 version 4.0.0.6909, released on August 31, 2023, the specifications for zooming in and out operations in the preprocessor window and visualization window were changed.
Before the change, zooming in and out was possible only with the mouse wheel, but after the change, zooming in and out is performed with the mouse wheel while pressing the Ctrl key. This change follows the "mouse hint" displayed in the iRIC.

In other words, the previous operation that could be performed without pressing the Ctrl key is a bug.

After the specification change, the sub-window will zoom in and out only when Ctrl is pressed, and the entire iRIC GUI screen will scroll when Ctrl is not pressed.

Before the specification change, the subwindow was zoomed in and out and the iRIC GUI screen was scrolled at the same time.

How to install iRIC and Solvers

KeitaHoshino — Fri, 25 Aug 2023 02:50:31 +0000

Introduction

The installation procedure is explained in the manual, but it is not detailed, so we will organize it with a diagram.

iRIC User's manual » Docs » Installation
https://iric-gui-user-manual.readthedocs.io/en/latest/01_install.html#installation

Registration is required to obtain iRIC. Please register and login in advance.

Download Installer

Access the iRIC website and ccess the download page.
Expand the Version 4.X contents list and click on the iRIC v4 installer 64bit download link.
The Terms of Use will be displayed. Click I agree and download at the bottom of the page.

The download will begin. Save the installer in a location of your choice.

Installation

Launch the iRIC_Installer_v4.exe downloaded earlier,and Click "Next.

If you are using a proxy in your environment, open the settings window from Settings in the lower left corner and select System proxy settings (the proxy settings used by your system will be used) in the Network tab. or select Manual proxy configuration and enter the proxy settings manually.
Specify the folder where iRIC will be installed and click Next. In most cases, it is not necessary to change the installation folder.

Select the Component to be installed and Click Next.

By default, all components will be installed except Miniconda3. (For more information on iRIC's Miniconda, see here.
You can select the Solver and Grid Generator you wish to install under Grid Generators and Solvers. You can uncheck those you do not use.(They can also be installed later.)
The license is displayed, select I accept the license and click Next.
Specify the folder name of the shortcut to be added to the Start menu, and Click Next (You do not need to change it.)
Click Next to begin installation.
Wait for the installation to finish. (If you are installing Miniconda, it will take a little longer.)
When the installation is finished, click Finish to close the installer.

How to install solvers later

Launch the maintenance tool.

There are several ways to start the maintenance tool.
- Launch from the shortcut iRIC Maintainance added to the Windows Start Menu
- Launch from Option-->maintenance after launching iRIC
- Directly launch maintenancetool.exe from the folder where you installed iRIC
Select Add or remove components and click `Next.
Check the Component you want to install and click Next (Uncheck the checkbox to uninstall.)
Click Next to begin installation.
Wait for the installation to finish. (If you are installing Miniconda, it will take a little longer.)
When the installation is finished, click Finish to close the installer.