-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathINSTALL.txt
190 lines (125 loc) · 7.46 KB
/
INSTALL.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
Incorporated Research Institutions for Seismology (IRIS)
Data Management Center (DMC)
Data Products Team
IRIS Earth Model Collaboration (EMC) - ParaView support bundle
COMMENTS/QUESTIONS:
Please contact [email protected]
Python 3
2021-10-03
======================================================================================================================================================================
DESCRIPTION:
This package provides a set of Python 3 programmable filters/sources to allow ParaView open-source, multi-platform data
analysis and visualization application to display EMC netCDF models along with other auxiliary Earth data. Once this
package is installed, the EMC plugins will appear in ParaView under the "Sources --> IRIS EMC" and
"Filters --> IRIS EMC" menus. For information on the contents of this package, see the CONTENTS section below.
NOTE: To use these plugins, you need basic familiarity with ParaView and how it operates. Please see ParaView Getting
Started Guide and ParaViewTutorial:
https://www.paraview.org/download/
REQUIREMENTS:
- ParaView: This package was created and tested using ParaView 5.9.1 under Mac OS X 11.5.2. ParaView can be
downloaded from https://www.paraview.org/
NOTE: test of these plugins under Windows OS is in the process
- Python: ParaView comes with Python 3. Therefore, Python 3 installation is needed to support this package.
This bundle was created and tested under Python 3.9.7.
NOTE: numpy package is required
PACKAGE INSTALLATION:
- Place the package where you want to install
- Extract (unzip and untar) the content. The plugins will be installed under the "IRIS_EMC_Paraview" directory.
Under this directory, the src, src/filters, src/macros, and src/readers directories and their contents that
are required for the installation will be created during unpacking. The scripts will create other needed
directories during the build process.
NOTE: This bundle will NOT create directories outside the IRIS_EMC_Paraview installation directory.
- Install the bundle by executing the Python 3 script "build_plugins_macros.py" under the src directory.
If the "build_plugins_macros.py" execution is successful, you should see three new directories under the
"IRIS_EMC_Paraview" directory:
plugins - Under this directory, you will find a series of XML files that are wrappers for the Python plugin
scripts that reside under src/filters and src/readers directories
macros - Under this directory you will find macros that are created based on the macro templates under the
src/macros
data - This directory does not contain any data files after the installation step. However, it will be used to
save data files as they are downloaded during ParaView runs
ADDING PLUGINS TO PARAVIEW:
- In ParaView, go to "Tools --> Manage Plugins.." and a Plugin Manager window opens. As you will see on this window,
you have two options:
* Option 1: Click on the "Load New" button and change the file type to xml, and load plugins from the
IRIS_EMC_Paraview/plugins directory. These plugins will remain active during this ParaView session, but
you have to reload them after each ParaView restart
* Option 2: As indicated on top of the Plugin Manager window, you may place your plugin files under the
designated plugin directory so they would be loaded automatically. A better option would be to assign
this directory to the "EMC_PLUGINS_PATH" parameter in IrisEMC_Paraview_Param.py so every time you
rebuild the bundle, plugins get updated. However, this option requires granting full permission to
the user for accessing this directory.
- Restart ParaView
- To tell ParaView NOT to apply changes in the 'Properties' panel, go to ParaView's Settings (Preferences), and
under "General," uncheck "Auto Apply"
- In ParaView, go to "Sources --> IRIS EMC" to see various EMC sources you have installed
- In ParaView, go to "Filters--> IRIS EMC" to see the single EMC filter you have installed (it should be grayed out
since you have no data to filter yet!)
USAGE:
IRIS EMC plugin installation is now complete, and you may now start using them as described in the README.txt
document of this package.
CONTENTS:
The package comes with the following directories and files:
IRIS_EMC_Paraview/src:
----------------------
Directory of all the installation scripts and plugin/macro scripts
- src/IrisEMC_Paraview_Lib.py
IRIS EMC ParaView Python library of functions called by the plugins
- src/IrisEMC_Paraview_Param.py
IRIS EMC ParaView Python parameter file that contains parameters accessed by the plugins
Users may change these parameters to change the default startup values.
- src/IrisEMC_Paraview_Utils.py
IRIS EMC ParaView Python library of utility functions called by the plugins
- src/build_plugins_macros.py
A Python script to build the bundle. Anytime user modifies any of the python scripts, this script must be executed
to update the plugins and macros
- src/python_filter_generator.py
A python script to wrap the existing Python scripts into an XML plugin
- src/python_macro_generator.py
A python script to prepare Python macros for installation
IRIS_EMC_Paraview/src/filters:
------------------------------
Directory of the programmable filters
- filter_view_coordinates.py
a programmable filter to display boundary coordinate information of the input in terms of lat, lon, depth
IRIS_EMC_Paraview/src/macros:
-----------------------------
Directory of macro templates. These Python scripts are based on the programmable filters and sources that are
designed to handle specific tasks, such as plotting earthquakes using proper symbol type, size, and color.
- macro_coastlines.py
Draw low-resolution coastline on Americas and draw the state boundaries for the US and Canada along with political
boundaries
- macro_earthquakes.py
Plot the 200 largest earthquakes in the Americas since 2001-01-01 using USGS event service
- macro_etopompy
Display surface elevation changes for Americas, using elevation data file
- macro_grids.py
Display latitude/longitude grids for Americas at 10 degrees intervals
- macro_plates.py
Display divergent, transform, and convergent plate boundaries for Americas
- macro_usgs_slabs.py
Display USGS Slab 1.0 model for Central America from earthquake.usgs.gov
- macro_volcanoes.py
Display volcano locations using WOVOdat data from ds.iris.edu
IRIS_EMC_Paraview/src/readers:
------------------------------
- read_2d_models.py
Read and display 2D netCDF/GeoCSV Earth models
- read_3d_models.py
Read and display 3D netCDF/GeoCSV Earth models
- read_boundaries.py
Draw boundaries by reading a selected boundary file based on the lat,lon limits
- read_coordinates_converter.py
Convers latitude, longitude and, depth to X, Y, and Z (Or Vice Versa)
- read_earhquakes.py
Get and display earthquake locations from FDSN Event Service
- read_etopo.py
Read and display surface elevation changes using elevation data file
- read_grids.py
Draw the latitude and longitude grid lines
- read_usgs_slab.py
Get/Read and display USGS Slab 1.0 models
- read_volcanoes.py
Read and display volcano locations
COMMENTS/:
Please contact [email protected]