Standard Script Summary

Table of Contents

Introduction

The following is a list of scripts that ship with the MineSight(r) suite of products.

Each script can be found in the $(medexe)/scripts and $(medexe)/scripts/reserve directories. Each of the scripts are prefixed to help indicate their purpose. In general the following convention is observed,

Prefix Description
EM Meant to be executed with MineSight(r) Grail Embedded, within MS3D.
SA Meant to be executed from the command line. In general these will have a *.cmd file that can be used to launch the application from explorer.
IP Meant to be executed within MineSight(r) Interactive Planner.
CP Meant to be executed as a MineSight(r) Compass procedure.

If a script can be run in multiple contexts, then it will have a combination of prefixes, where the first prefix is the preferred version. For example:

em_sa_myscript.py

Can be executed as an Embedded script from MS3D or from the command line, but the preferred method is via MS3D.

General

The following scripts are for general usage within the MineSight® system.

File Summary
attrtoascii Convert attributed geometry MSR to Concsa input files.
contoursFromDir Loops through source directory inspecting all .msr files for shells elements (surfaces and solids). If shell elements are found, contours them into new cooresponding objects in target directory. If successful, for each object with shells in source directory, there will be an object with groups of contours, one group for each shell element, in target directory.
createPartials Creates partials files for every shell element (surface or solid) in all of the geometry objects of a specified directory.
em-ImportCutsToMSPD Import Cuts To MSPD
em-WasteDumpSequencer  
em-info Displays MSGRAIL/Python information to the MS3D message window.
em-materials Reports material references for all geometry objects selected in Data Manager.
em-polystats Reports polyline/polgyon median and standard deviation elevations.
em-project-bounding-box Generates a Project Bounding Box Geometry in a \ProjectBoundingBox object.
ip-BottomLevelFinder Bottom Level Finder Utility (for GSM only)
minesight-info Gets information about the computer and MineSight(r) dependencies.
poly2dRpt  
sa-Surpac_To_MSR sa-Surpac_To_MSR.py May 19, 2009 ADF Original Version. May 30, 2013 ADF Modified to import each object as a separate element under the same geometry object (named after the Surpac ID)
shellRpt Creates a Comma Delimited (CSV) file of characteristics of all solids and surfaces (shells) in a geometry object or from all geometry objects in a directory.

em-sdip_polylines_to_composites

Convert hangingwall/footwall polylines into composite drillholes (complex coal)

File Summary
em-sdip_polylines_to_composites This tool is used to convert hangingwall/footwall polylines into composite drillholes. (complex coal) A temporary file 9 is generated each run. Every drillhole interval will be assigned the following values: - Seam Dip: calculated from the start/end coordinates of the corresponding polyline segment. - Seam Code: obtained by looking up the model code associated with the MSR material.

MSIP-ARM

The following scripts belong to the MSIP-ARM suite.

File Summary
ipAttributer ipAttributer is used to calculate values for attributes in MSIP. It is managed by the ipManager script.
ipManager The ipManager is used to manage the settings for ipAttribute and ipRelease.
ipRelease ipRelease is used to 'Release' cuts from MSIP in a variety of formats. It is managed by the ipManager script.

Reserves (MSIP)

The following scripts are for use within MineSight(r) Interactive Planner (MSIP).

File Summary
batch-ip-accum Batch version of the Default MineSight Interactive Planner (MSIP) accumulation script.
batch-ip-allflatreport Batch version of Default Flat file MineSight Interactive Planner reporting script. This script differs from the ip default script as it does not get equipment values.
batch-ip-flatreport Batch version of Flat file MineSight(r) Interactive Planner (MSIP) reporting script.
batch-ip-period Batch version of ip-period.py report script.
batch-ip-report Batch version of ip-report.py script.
batch-ip-summary Batch script equivalent of ip-summary.py. Script for reporting one or two ore/coal types (eg. met and ox).
eq-report General Equipment Handling Script Framework.
eq-setup Sets up for equipment reporting.
ip-accum Default MineSight Interactive Planner accumulation script.
ip-allflatreport Flat file MineSight Interactive Planner reporting script.
ip-flatreport Flat file MSIP reporting script.
ip-label Default MineSight Interactive Planner (MSIP) Plotting Script.
ip-period Default MineSight Interactive Planner (MSIP) period report script.
ip-printdict Dumps the contents of the Reserves Dictionary to a file.
ip-report Default MineSight Interactive Planner (MSIP) reporting script.
ip-shiftcuts Insert cuts into your plan shifted by some desired amount.
ip-summary Script for reporting one or two ore/coal types (eg. met and ox).

Samples

Listing of various sample files. These scripts can be found in $(medexe)\scripts\samples.

File Summary
basic-boilerplate Basic boilerplate script for MineSight Grail.
em-boilerplate Standard boilerplate script for MS-Grail Embedded scripts.
em-helloworld Sample script illustrates printing to the datamanager.
em-modelcalc_boilerplate Block Model calculation boilerplate (REF #10181)
ip-boilerplate Standard boilerplate script for MSGRAIL Interactive Planner scripts.
pyz-boilerplate Standard boilerplate script for MS-Grail PYZ scripts.

grail.data.agdm

Illustrates how to access the Attributed Geometry Data Model (AGDM) using python and MineSight(r) Grail.

File Summary
ex1-open-close AGDM Example #1: Indicates basic open/close operations on AGDM.
ex2-add-shells AGDM Example #2: Add Geometry from a Geometry MSR
ex3-define-custom-attribute AGDM Example #3: Indicates how to define a custom attribute.
ex4-setting-custom-attributes AGDM Example #4: Setting custom attributes.
ex5-iterate-through-geometries-in-a-plan AGDM Example #5: Iterating through geometries in a plan.
ex6-date-fields AGDM Example #6: Working with Date Fields.

grail.data.lgomodule

Illustrates how to access the Large Gridded Objects (LGOs) via MineSight(r) Grail and Python.

File Summary
lgo-sample-thickness LGO Surface Thickness calculation for MineSight Grail.

grail.images

Sample scripts that use the images module within MineSight(r) Grail.

File Summary
ImageSample Displays all available images in the grail.images library.

grail.ms3d.datamanager

Scripts that illustrate working with MineSight(r) 3D's Datamanager via MineSight(r) Grail Embedded (MSGe) and Python.

File Summary
em-list-filtered Sample illustrates the use of datamanager.list_filtered() function.

grail.ms3d.element

An Element in MineSight Grail Embedded (MSGe) is a basic piece of data (for example a polyline, marker, label, surface, &etc). The follow scripts illustrate how you can use the Element within the context of MSGe.

File Summary
em-sample-create-label Create label for a MineSight Grail Embedded application.
em-sample-create-non-transform-label Create a non-transform label for a MineSight Grail Embedded application.
em-sample-create-semi-transform-label Create semi-transform label for a MineSight Grail Embedded application.
em-sample-create-transform-label Create a transform label for a MineSight Grail Embedded application.

grail.ms3d.elementop

Working with Element objects within MineSight(r) 3D via MineSight(r) Grail Embedded (MSGe) will sometimes involve doing certain operations. The following scripts illustrate how to perform these operations.

File Summary
em-calculate-area Demonstrates how to calculate areas for polygons.

grail.ms3d.project

Illustrates how to use MineSight(r) Grail Embedded (MSGe) to access the project settings from within MineSight(r) 3D.

File Summary
em-project Example of querying the MS3D project for details.

grail.ms3d.selectionbuffer

Illustrates how to use MineSight(r) Grail Embedded (MSGe) to access the selected data from within MineSight(r) 3D.

File Summary
em-selectionbuffer Illustrates how to get elements selected by the user.