You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Other requirements are addressed in the [installation](#installation) section below.
42
-
43
-
## Installation
44
-
45
-
Follow the directions in the sdutil documentation for [running sdutil in Azure environments](https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/seismic/seismic-dms-suite/seismic-store-sdutil/-/tree/azure/stable#setup-and-usage-for-azure-env).
46
-
47
-
The utility requires other modules noted in [requirements.txt](https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/seismic/seismic-dms-suite/seismic-store-sdutil/-/blob/azure/stable/requirements.txt). You could either install the modules as is or install them in virtualenv to keep your host clean from package conflicts. If you don't want to install them in a virtual environment, jump directly to step 3.
41
+
The utility requires other modules noted in [requirements.txt](https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/seismic/seismic-dms-suite/seismic-store-sdutil/-/blob/azure/stable/requirements.txt). You could either install the modules as is or install them in virtualenv to keep your host clean from package conflicts. If you don't want to install them in a virtual environment, skip the four virtual environment commands below. Additionally, if you are using Mac instead of Ubuntu or WSL - Ubuntu 20.04, either use `homebrew` instead of `apt-get` as your package manager, or manually install `apt-get`.
48
42
49
43
```bash
50
44
# check if virtualenv is already installed
51
45
virtualenv --version
52
46
53
-
# if not install it via pip
47
+
# if not install it via pip or apt-get
54
48
pip install virtualenv
49
+
# or sudo apt-get install python3-venv for WSL
55
50
56
51
# create a virtual environment for sdutil
57
52
virtualenv sdutilenv
53
+
# or python3 -m venv sdutilenv for WSL
58
54
59
55
# activate the virtual environemnt
60
56
Windows: sdutilenv/Scripts/activate
@@ -64,99 +60,99 @@ The utility requires other modules noted in [requirements.txt](https://community
64
60
Install required dependencies:
65
61
66
62
```bash
67
-
# run it from the extracted sdutil folder
63
+
# run this from the extracted sdutil folder
68
64
pip install -r requirements.txt
69
65
```
70
66
71
67
## Usage
72
68
73
69
### Configuration
74
70
75
-
1. Clone the [sdutil repository](https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/seismic/seismic-dms-suite/seismic-store-sdutil/-/tree/azure/stable) and open in your favorite editor.
71
+
1. Clone the [sdutil repository](https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/seismic/seismic-dms-suite/seismic-store-sdutil/-/tree/azure/stable)from the community Azure Stable branch and open in your favorite editor.
76
72
77
73
2. Replace the contents of `config.yaml` in the `sdlib` folder with the following yaml and fill in the three templatized values (two instances of `<meds-instance-url>` and one `<put refresh token here...>`):
1. Run the utility from the extracted utility folder by typing:
115
111
116
-
```bash
117
-
python sdutil
118
-
```
119
-
120
-
If no arguments are specified, this menu will be displayed:
121
-
122
-
```code
123
-
Seismic Store Utility
124
-
125
-
> python sdutil [command]
112
+
```bash
113
+
python sdutil
114
+
```
126
115
127
-
available commands:
116
+
If no arguments are specified, this menu will be displayed:
128
117
129
-
* auth : authentication utilities
130
-
* unlock : remove a lock on a seismic store dataset
131
-
* version : print the sdutil version
132
-
* rm : delete a subproject or a space separated list of datasets
133
-
* mv : move a dataset in seismic store
134
-
* config : manage the utility configuration
135
-
* mk : create a subproject resource
136
-
* cp : copy data to(upload)/from(download)/in(copy) seismic store
137
-
* stat : print information like size, creation date, legal tag(admin) for a space separated list of tenants, subprojects or datasets
138
-
* patch : patch a seismic store subproject or dataset
139
-
* app : application authorization utilities
140
-
* ls : list subprojects and datasets
141
-
* user : user authorization utilities
142
-
```
118
+
```code
119
+
Seismic Store Utility
120
+
121
+
> python sdutil [command]
122
+
123
+
available commands:
124
+
125
+
* auth : authentication utilities
126
+
* unlock : remove a lock on a seismic store dataset
127
+
* version : print the sdutil version
128
+
* rm : delete a subproject or a space separated list of datasets
129
+
* mv : move a dataset in seismic store
130
+
* config : manage the utility configuration
131
+
* mk : create a subproject resource
132
+
* cp : copy data to(upload)/from(download)/in(copy) seismic store
133
+
* stat : print information like size, creation date, legal tag(admin) for a space separated list of tenants, subprojects or datasets
134
+
* patch : patch a seismic store subproject or dataset
135
+
* app : application authorization utilities
136
+
* ls : list subprojects and datasets
137
+
* user : user authorization utilities
138
+
```
143
139
144
140
2. If this is your first time using the tool, you must run the sdutil config init command to initialize the configuration.
145
141
146
-
```bash
147
-
python sdutil config init
148
-
```
142
+
```bash
143
+
python sdutil config init
144
+
```
149
145
150
146
3. Before you start using the utility and performing any operations, you must sign in the system. When you run the following sign in command, sdutil will open a sign in page in a web browser.
151
147
152
-
```bash
153
-
python sdutil auth login
154
-
```
148
+
```bash
149
+
python sdutil auth login
150
+
```
155
151
156
-
Once you've successfully logged in, your credentials will be valid for a week. You don't need to sign in again unless the credentials expired (after one week), in this case the system will require you to sign in again.
152
+
Once you've successfully logged in, your credentials will be valid for a week. You don't need to sign in again unless the credentials expired (after one week), in this case the system will require you to sign in again.
157
153
158
-
> [!NOTE]
159
-
> If you aren't getting the "sign in Successful!" message, make sure your three environment variables are set and you've followed all steps in the "Configuration" section above.
154
+
> [!NOTE]
155
+
> If you aren't getting the "sign in Successful!" message, make sure your three environment variables are set and you've followed all steps in the "Configuration" section above.
160
156
161
157
## Seistore Resources
162
158
@@ -305,111 +301,55 @@ Run the changelog script (`./changelog-generator.sh`) to automatically generate
305
301
./scripts/changelog-generator.sh
306
302
```
307
303
308
-
## Setup and usage for Microsoft Energy Data Services
304
+
## Usage for Microsoft Energy Data Services
309
305
310
-
Below steps are for Windows Subsystem for Linux - Ubuntu 20.04
311
-
Microsoft Energy Data Services instance is using OSDU™ M12 Version of sdutil
306
+
Microsoft Energy Data Services instance is using OSDU™ M12 Version of sdutil. Follow the below steps if you would like to use SDUTIL to leverage the SDMS API of your MEDS instance.
312
307
313
-
1.Download the source code from community [sdutil](https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/seismic/seismic-dms-suite/seismic-store-sdutil/-/tree/azure/stable/) Azure Stable branch.
308
+
1. Ensure you have followed the [installation](#prerequisites) and [configuration](#configuration) steps from above. This includes downloading the SDUTIL source code, configuring your python virtual environment, editing the `config.yaml` file and setting your three environment variables.
314
309
315
-
2.In case python virtual env isn't installed, use below commands. Otherwise, skip to next section
310
+
2. Run below commands to sign in, list, upload and download files in the seismic store.
316
311
317
-
```bash
318
-
sudo apt-get update
319
-
sudo apt-get install python3-venv
320
-
```
321
-
322
-
3. Create a new virtual environment and install package
323
-
324
-
```bash
325
-
#create new virtual env with name : sdutilenv
326
-
python3 -m venv sdutilenv
327
-
328
-
#activate the virtual end
329
-
source sdutilenv/bin/Activate
330
-
331
-
#install python package for sdutil
332
-
pip install -r requirements.txt
333
-
```
334
-
335
-
4. Replace the contents of `config.yaml` in the `sdlib` folder with the following yaml and fill in the three templatized values (tow `<meds-instance-url>` and `<put refresh token here...>`):
> Don't use `cp` command to download VDS files. The VDS conversion results in multiple files, therefore the `cp` command won't be able to download all of them in one command. Use either the [SEGYExport](https://osdu.pages.opengroup.org/platform/domain-data-mgmt-services/seismic/open-vds/tools/SEGYExport/README.html) or [VDSCopy](https://osdu.pages.opengroup.org/platform/domain-data-mgmt-services/seismic/open-vds/tools/VDSCopy/README.html) tool instead. These tools use a series of REST calls accessing a [naming scheme](https://osdu.pages.opengroup.org/platform/domain-data-mgmt-services/seismic/open-vds/connection.html) to retrieve information about all the resulting VDS files.
351
+
> [!NOTE]
352
+
> Don't use `cp` command to download VDS files. The VDS conversion results in multiple files, therefore the `cp` command won't be able to download all of them in one command. Use either the [SEGYExport](https://osdu.pages.opengroup.org/platform/domain-data-mgmt-services/seismic/open-vds/tools/SEGYExport/README.html) or [VDSCopy](https://osdu.pages.opengroup.org/platform/domain-data-mgmt-services/seismic/open-vds/tools/VDSCopy/README.html) tool instead. These tools use a series of REST calls accessing a [naming scheme](https://osdu.pages.opengroup.org/platform/domain-data-mgmt-services/seismic/open-vds/connection.html) to retrieve information about all the resulting VDS files.
0 commit comments