Basic usage

Pro Geology and Pro Geophysics

To run SciGeoh5 applications from Geoscience ANALYST Pro Geophysics or Pro Geology, users must open the Geophysics menu, then Processing and select an application from the list.

From the package

The main entry points to the various modules are ui.json file (stored under the scigeoh5-assets directory). The ui.json has the dual purpose of (1) rendering a user-interface from Geoscience ANALYST and (2) storing the input parameters chosen by the user for the program to run. To learn more about the ui.json interface visit the UIJson documentation page.

User-interface

The user-interface is rendered in ANALYST Pro by one of two methods. Users can either drag-and-drop the ui.json file to the viewport:

Alternatively, users can add the application to the choice list of ANALYST Python scripts:

Note that users must close/re-open the ANALYST workspace for the changes to take effect.

From command line

With its installation, the package provides scripts to run from command line.

Note

If installed within a conda environment, first activate the environment with:

$ conda activate <env_name>

where <env_name> is the name of the conda environment.

The application can be run from the command line if all required fields in the ui.json are provided. This is useful for more advanced users that may want to automate the process, or re-run an existing input file with different parameters.

To run the application from the command line, use the following:

$ python -m scigeoh5.[module].driver <path_to_ui.json>

where path_to_ui.json is the path on disk to a JSON file with the required input parameters, and [module] is the name of the module to run. For example, to run the scigeoh5.pca module, use:

$ python -m scigeoh5.pca.driver <path_to_ui.json>