======================= Standard Script Summary ======================= .. contents:: Table of Contents :backlinks: top ------------ Introduction ------------ The following is a list of scripts that ship with the MineSight(r) suite of products. Each script can be found in the :file:`$(medexe)/scripts` and :file:`$(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. .. _attrtoascii: attrtoascii.html .. _contoursFromDir: contoursFromDir.html .. _createPartials: createPartials/createPartials.html .. _em-ImportCutsToMSPD: em-ImportCutsToMSPD.html .. _em-info: em-info.html .. _em-materials: em-materials.html .. _em-polystats: em-polystats.html .. _em-project-bounding-box: em-project-bounding-box.html .. _em-WasteDumpSequencer: em-WasteDumpSequencer/em-WasteDumpSequencer.html .. _ip-BottomLevelFinder: ip-BottomLevelFinder.html .. _minesight-info: minesight-info.html .. _poly2dRpt: poly2dRpt/poly2dRpt.html .. _sa-Surpac_To_MSR: sa-Surpac_To_MSR.html .. _shellRpt: shellRpt.html .. Column 1 = 26 .. Column 2 = 102 ========================== ====================================================================================================== 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) .. _em-sdip_polylines_to_composites: em-sdip_polylines/em-sdip_polylines_to_composites.html .. Column 1 = 34 .. Column 2 = 94 ================================== ============================================================================================== 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. .. _ipAttributer: MSIP-ARM/ipAttributer.html .. _ipManager: MSIP-ARM/ipManager.html .. _ipRelease: MSIP-ARM/ipRelease.html .. Column 1 = 15 .. Column 2 = 113 =============== ================================================================================================================= 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). .. _batch-ip-accum: reserve/batch-ip-accum.html .. _batch-ip-allflatreport: reserve/batch-ip-allflatreport.html .. _batch-ip-flatreport: reserve/batch-ip-flatreport.html .. _batch-ip-period: reserve/batch-ip-period.html .. _batch-ip-report: reserve/batch-ip-report.html .. _batch-ip-summary: reserve/batch-ip-summary.html .. _eq-report: reserve/eq-report.html .. _eq-setup: reserve/eq-setup.html .. _ip-accum: reserve/ip-accum.html .. _ip-allflatreport: reserve/ip-allflatreport.html .. _ip-flatreport: reserve/ip-flatreport.html .. _ip-label: reserve/ip-label.html .. _ip-period: reserve/ip-period.html .. _ip-printdict: reserve/ip-printdict.html .. _ip-report: reserve/ip-report.html .. _ip-shiftcuts: reserve/ip-shiftcuts.html .. _ip-summary: reserve/ip-summary.html .. Column 1 = 25 .. Column 2 = 103 ========================= ======================================================================================================= 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 :file:`$(medexe)\\scripts\\samples`. .. _basic-boilerplate: samples/basic-boilerplate.html .. _em-boilerplate: samples/em-boilerplate.html .. _em-helloworld: samples/em-helloworld.html .. _em-modelcalc_boilerplate: samples/em-modelcalc_boilerplate.html .. _ip-boilerplate: samples/ip-boilerplate.html .. _pyz-boilerplate: samples/pyz-boilerplate.html .. Column 1 = 27 .. Column 2 = 101 =========================== ===================================================================================================== 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. .. _ex1-open-close: samples/grail.data.agdm/ex1-open-close.html .. _ex2-add-shells: samples/grail.data.agdm/ex2-add-shells.html .. _ex3-define-custom-attribute: samples/grail.data.agdm/ex3-define-custom-attribute.html .. _ex4-setting-custom-attributes: samples/grail.data.agdm/ex4-setting-custom-attributes.html .. _ex5-iterate-through-geometries-in-a-plan: samples/grail.data.agdm/ex5-iterate-through-geometries-in-a-plan.html .. _ex6-date-fields: samples/grail.data.agdm/ex6-date-fields.html .. Column 1 = 43 .. Column 2 = 85 =========================================== ===================================================================================== 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. .. _lgo-sample-thickness: samples/grail.data.lgomodule/lgo-sample-thickness.html .. Column 1 = 23 .. Column 2 = 105 ======================= ========================================================================================================= 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. .. _ImageSample: samples/grail.images/ImageSample.html .. Column 1 = 14 .. Column 2 = 114 ============== ================================================================================================================== 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. .. _em-list-filtered: samples/grail.ms3d.datamanager/em-list-filtered.html .. Column 1 = 19 .. Column 2 = 109 =================== ============================================================================================================= File Summary =================== ============================================================================================================= `em-list-filtered`_ Sample illustrates the use of datamanager.list_filtered() function. =================== ============================================================================================================= grail.ms3d.element ------------------ An :c:`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 :c:`Element` within the context of MSGe. .. _em-sample-create-label: samples/grail.ms3d.element/em-sample-create-label.html .. _em-sample-create-non-transform-label: samples/grail.ms3d.element/em-sample-create-non-transform-label.html .. _em-sample-create-semi-transform-label: samples/grail.ms3d.element/em-sample-create-semi-transform-label.html .. _em-sample-create-transform-label: samples/grail.ms3d.element/em-sample-create-transform-label.html .. Column 1 = 40 .. Column 2 = 88 ======================================== ======================================================================================== 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 :c:`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. .. _em-calculate-area: samples/grail.ms3d.elementop/em-calculate-area.html .. Column 1 = 20 .. Column 2 = 108 ==================== ============================================================================================================ 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. .. _em-project: samples/grail.ms3d.project/em-project.html .. Column 1 = 13 .. Column 2 = 115 ============= =================================================================================================================== 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. .. _em-selectionbuffer: samples/grail.ms3d.selectionbuffer/em-selectionbuffer.html .. Column 1 = 21 .. Column 2 = 107 ===================== =========================================================================================================== File Summary ===================== =========================================================================================================== `em-selectionbuffer`_ Illustrates how to get elements selected by the user. ===================== ===========================================================================================================