INI File Specifications

Sections List:

1. mscode_options

2. code_options

3. code_zone_X

4. code_polygon_options

5. code_plane_X

6. code_model_options

7. code_gsm_plane_X

8. code_surface_options

9. geometry_X

10. dh_limiting

NOTE:  Any key with "X" is expecting a numeric value, i.e. [code_plane_X] will have [code_plane_1], [code_plane_2], and so on.  The key value pairs below are listed in the order they are exported from MS3D.

1. Section [mscode_options]

This section is for MSCODE.EXE specific options.  

project_path="string value"

Optional.  Default: None.

The path to the folder in the project that contains _msresources.

This value can be omitted only when:

• The geometry set contains complete paths.

• The geometry set has code values for every group.

• code_order is used with any priority ordering operation.

geometry_set_name="string value"

Optional.  Default: None.

The name of the geometry set in the geomset.xml to load.

This value is ignored when a [geometry_1] section is found.  project_path must be set to use this value.

pcf_path="string value"

Required.  Default: None.

The path to the pcf file.

pcf_model_file="string value"

Optional.  Default: None.

The file name of the model as it appears in the pcf file.  Do not use any path prefix.  Do not use in conjunction with pcf_dh_intervals_file value.

gsm_ztop_item="String Value"

Required when using a GSM for pcf_model_file.  Default: None.

The name of the item to use for the seam top level.

gsm_zbot_item="String Value"

Required when using a GSM for pcf_model_file.  Default: None.

The name of the item to use for the seam bottom level.

pcf_dh_intervals_file="string value"

Optional.  Default: None.

The file name of the dh intervals file as it appears in the pcf file.  Do not use any path prefix.  Do not use in conjunction with pcf_model_file value.

pcf_dh_survey_file="string value"

Optional.  Default: None.

The file name of the dh survey file as it appears in the pcf file.  Do not use any path prefix.  Do not use in conjunction with pcf_model_file value.

dh_geometry_type=enum value

Required when pcf_dh_intervals_file value is present.  Default: unknown.

The geometry type of the pcf dh set.

Values:

• unknown

• none

• survey

• start_end

• end_bench

• end_length

dh_geometry_item_X="string value"

Required when dh_geometry_type value is present.  Default: None.  From 1 up to 6.

The dh item names that are used to define the geometry in the pcf dh set.

dh_id_type=enum value

Required when pcf_dh_intervals_file value is present.  Default: unknown.

The dh id type of the pcf dh set.

Values:

• unknown

• survey

• ref

• dhid1

• dhid2

• survey_alpha1

• survey_alpha2

dh_id_item_X="string value"

Required when dh_id_type value is present.  Default: None.  From 1 up to 2.

The dh item names that are used to define the dh id in the pcf dh set.

subcell=integer value

Optional.  Default: 10.

The number of subcells to use when coding a block model from solids.

item_filter="string value"

Optional.  Default: None.

The item filter expression string that is used during model and dh coding and resting.  When this expression evaluates to false, the block will not become coded.  Any undefined value that is encountered for the items in the expression will be treated as false.

model_column_min=integer value

model_column_max=integer value

model_row_min=integer value

model_row_max=integer value

model_level_min=integer value

model_level_max=integer value

Optional.  Default: Model Limits.

The range to use to code the model.  Any blocks outside of this range will not be affected from the reset or coding.

no_progress=boolean value

Optional.  Default: false.  Same as: -np

Indicates that MSCODE.EXE should not display a progress indicator.  Use "true" or "false".

quiet_mode=boolean value

Optional.  Default: false.  Same as: -q

Indicates that MSCODE.EXE should not display any output other than errors.  Use "true" or "false".

template_file="string value"

Optional.  Default: None.  Same as: -t <file name>

The MSCODE.EXE template file that should be loaded.  Any values in the INI file will overwrite the values in the template file.

output_file="string value"

Optional.  Default: None.  Same as: -o <file name>

The output file name used for partials or area speciation.  Can only be used when template or INI contains a model file value.  If this value is present, the model will not be coded.

free_format=boolean value

Optional.  Default: false.  Same as: -f

Indicates that the output file should use free format columns.  Use "true" or "false".

real_format=boolean value

Optional.  Default: false.  Same as: -r

Indicates that the output file should use real (float) values.  Use "true" or "false".

area_specification=boolean value

Optional.  Default: false.  Same as: -a

Indicates that the output file should be an area specification file.  Use "true" or "false".

(Note:  old misspelling, "area_specfication" is still accepted for backward compatibility)

code_order=integer or float list

Required when project_path value is not present and coding models with priority order.  Default: None.

The list of comma separated code values in there priority order.

ignore_elem_names=boolean value

Optional.  Default: false.  Same as: -nn

Indicates the element name grouping should be ignored and use all elements in the objects listed in the Geometry Set.  Use "true" or "false".

limit_dhs=boolean value

Optional.  Default: false.

Indicates that MSCODE>EXE should limit the drillholes to code.  See Section [dh_limiting].  Use "true" or "false".

2. Section [code_options]

This section is for general coding options.

code_from=enum value

Optional.  Default: solids.

The geometry type to code from.

Values:

• solids

• polygons

code_type=enum value

Optional.  Default: code_majority.

The coding type.

Values:

code_waste=enum value

Optional.  Default: none.

The code partial type.

Values:

threshold=float value

Optional.  Default: 0.0

Smallest total partial allowed.

combine_type=enum value

Optional.  Default: none.

Combine entry (leftover partial) type.

Values:

combine_item="string value"

Required when combine_type=item is present.  Default: None.

The item to add the extra partial value to.

normalize_type=enum value

Optional.  Default: none.

Normalization type.

Values:

normalize_item="string value"

Optional.  Default: None.

Normalization item.

normalize_tolerance=integer value

Optional.  Default: 0

Normalization percent tolerance.

reset=boolean value

Optional.  Default: false.

Reset the item values before coding.  Use "true" or "false".

reset_code=float value

Optional.  Default: - (undefined)

Reset value for code item.

reset_percent=float value

Optional.  Default: - (undefined)

Reset value for percent item.

3. Section [code_zone_X]

This section is for each code zone item.  The code zone index number should be increasing order continuously starting from 1.

code_item="string value"

Required for code_from with a value that contains the word “code”.  Default: None.

The item to store the code value to.

percent_item="string value"

Required for code_from with a value that contains the word “percent”.  Default: None.

The item to store the percent value to.

zone_code=integer or float value

Required for code_from=percent_priority.  Default: 0

The code number to store the percent value from.

4. Section [code_polygon_options]

This section is for options that are used when coding from polygons.

plane_type=enum value

Optional.  Default: generate.

The type of the plane list definition.

Values:

plane_tolerance=float value

Optional.  Default: 0.001

The tolerance to place a polygon on a plane.

remove_unused_planes=boolean value

Optional.  Default: false.

Removes any planes from the plane list that does not have a polygon that was placed on it.  Use "true" or "false".

influence_type=enum value

Optional.  Default: split.

The coding influence type.

Values:

influence=float value

Optional.  Default: 0.0

The max coding influence distance.  Zero for none.

group_by=enum value

Optional.  Default: code.

The polygon grouping type.

Values:

code_one_group_at_a_time=boolean value

Optional.  Default: false.

Run the polygon coding separately for each polygon group.  Use "true" or "false".

5. Section [code_plane_X]

This section is for each plane in the plane list.  The index number should be increasing order continuously starting from 1.

plane_equation=plane equation

Required.  Default: None.

The plane equation defining the plane.  All the planes should be parallel.

Equation is in the form of = a b c d where ax + by + cz + d = 0.

plane_name="string value"

Optional.  Default: Generated from plane equation.

The Name of the plane to be referenced in output messages.

6. Section [code_model_options]

This section options for coding models from polygons.

orientation=enum value

Optional.  Default: xy.

The direction to code the model with.  (from polygons)

Values:

plane_start=float value

Optional.  Default: 0.0

Used to define the starting plane value when using plane_type=generate.

plane_end=float value

Optional.  Default: 0.0

Used to define the ending plane value when using plane_type=generate.

plane_step=float value

Optional.  Default: 0.0

Used to define the plane step value when using plane_type=generate.

use_block_centers=boolean value

Optional.  Default: false.

Use the block centers for coding.  Use "true" or "false".

number_of_passes=integer value

Optional.  Default: 10.

The number of passes to code from polygons.

use_vertical_slices=boolean value

Optional.  Default: false.

Use vertical when coding the model.  Use "true" or "false".

polygons_as_solids=boolean value

Optional.  Default: false.

Create extruded solids from polygons using the rules defined in code_polygon_options and then code the model from solids rather than from polygons. Only 3DBM and Sub-block models are supported. Use "true" or "false".

7. Section [code_gsm_plane_X]

This section is for each GSM level when coding a GSM from polygons.  The index number should be increasing order continuously starting from 1.

gsm_name="string value"

Required.  Default: None.

The GSM level name.

plane_index=integer value

Optional.  Default: -1

The plane index number from the [code_plane_X] list.  -1 for none.  Used for plane_type=gsm.

plane_level=float value

Required when plane_type=generate.  Default: None.

The plane level.

8. Section [code_surface_options]

direction=enum value

Optional.  Default Value: below

The direction to code the model from the surface.

Values:

• above     - Code the model above the surface

• below     - Code the model below the surface

9. Section [geometry_X]

This section is for each geometry in the geometry set.  If the geometry set is defined here, the one specified by geometry_set_name will be ignored.  The index number should be increasing order continuously starting from 1.

object="string value"

Required.  Default: None.

The path to the geometry object file.

type=enum value

Required.  Default: None.

The geometry type.

Values:

• points

• polys

• solids

• text

name="string value"

Optional.  Default: None.

The name of the elements to include in this group.  If not specified, unattributed elements are used.  If an element has a named attribute, then you must specify the attributed name.

code=integer or float value

Optional.  Default: Material Model Code.

The model code value to use for this group.  If not specified, the material’s model code value is used.  The code can be an integer or a real (float) value.

10. Section [dh_limiting]

This section lists the drillholes by name that should be coded when limit_dhs is set to true in the [mscode_options] section.  If limit_dhs is set to false, this section is ignored and all drillholes are coded.  The drillhole names that are listed here are numbered starting from 1 in the format x="Drillhole Name", where x is the increasing number.