pyadps 0.2.0b0__tar.gz → 0.2.1b0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/PKG-INFO +51 -20
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/README.md +51 -20
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/pyproject.toml +1 -1
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/pages/01_Read_File.py +4 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/pages/03_Download_Raw_File.py +4 -4
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/LICENSE +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/Home_Page.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/__init__.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/__main__.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/pages/02_View_Raw_Data.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/pages/04_QC_Test.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/pages/05_Profile_Test.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/pages/06_Velocity_Test.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/pages/07_Write_File.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/pages/__init__.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/__init__.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/autoprocess.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/cutbin.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/metadata/config.ini +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/metadata/flmeta.json +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/metadata/vlmeta.json +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/plotgen.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/profile_test.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/pyreadrdi.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/readrdi.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/regrid.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/script.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/signal_quality.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/velocity_test.py +0 -0
- {pyadps-0.2.0b0 → pyadps-0.2.1b0}/src/pyadps/utils/writenc.py +0 -0
@@ -1,6 +1,6 @@
|
|
1
1
|
Metadata-Version: 2.1
|
2
2
|
Name: pyadps
|
3
|
-
Version: 0.2.
|
3
|
+
Version: 0.2.1b0
|
4
4
|
Summary: A Python package for ADCP data processing
|
5
5
|
Home-page: https://example.com
|
6
6
|
License: MIT
|
@@ -31,9 +31,21 @@ Description-Content-Type: text/markdown
|
|
31
31
|
|
32
32
|
# pyadps
|
33
33
|
|
34
|
-
`pyadps` is a Python package for processing moored Acoustic Doppler
|
34
|
+
`pyadps` is a Python package for processing moored Acoustic Doppler
|
35
|
+
Current Profiler (ADCP) data. It provides various functionalities
|
36
|
+
such as data reading, quality control tests, NetCDF file creation,
|
37
|
+
and visualization.
|
35
38
|
|
36
|
-
This software offers both a graphical interface (`Streamlit`) for
|
39
|
+
This software offers both a graphical interface (`Streamlit`) for
|
40
|
+
those new to Python and direct Python package access for experienced
|
41
|
+
users. Please note that `pyadps` is primarily designed for Teledyne
|
42
|
+
RDI workhorse ADCPs. Other company's ADCP files are not compatible,
|
43
|
+
and while some other RDI models may work, they might require additional
|
44
|
+
considerations.
|
45
|
+
|
46
|
+
- Documentation: <https://pyadps.readthedocs.io>
|
47
|
+
- Source code: <https://github.com/p-amol/pyadps>
|
48
|
+
- Bug reports: <https://github.com/p-amol/pyadps/issues>
|
37
49
|
|
38
50
|
## Table of Contents
|
39
51
|
|
@@ -43,37 +55,49 @@ This software offers both a graphical interface (`Streamlit`) for those new to P
|
|
43
55
|
|
44
56
|
## Installation
|
45
57
|
|
46
|
-
We recommend installing the package within a virtual environment.
|
47
|
-
|
58
|
+
We recommend installing the package within a virtual environment.
|
59
|
+
At present, the package is compatible exclusively with Python version 3.12.
|
60
|
+
You can create a Python environment using tools like `venv` or `conda`.
|
61
|
+
Below are instructions for both methods.
|
48
62
|
|
49
63
|
### 1. Using `venv` (Built-in Python Tool)
|
50
64
|
|
51
65
|
#### Step 1: Install Python version 3.12 (if not already installed)
|
66
|
+
|
52
67
|
Ensure you have Python installed. You can download the latest version from [python.org](https://www.python.org/downloads/).
|
53
68
|
|
54
|
-
#### Step 2: Create a Virtual Environment
|
69
|
+
#### Step 2: Create a Virtual Environment
|
70
|
+
|
55
71
|
- Open your terminal or command prompt.
|
56
72
|
- Navigate to your project folder:
|
73
|
+
|
57
74
|
```bash
|
58
75
|
cd /path/to/your/project
|
59
76
|
```
|
60
|
-
|
77
|
+
|
78
|
+
- Run the following command to create a virtual environment
|
79
|
+
(replace adpsenv with your preferred environment name):
|
61
80
|
|
62
81
|
```bash
|
63
82
|
python -m venv adpsenv
|
64
83
|
```
|
65
84
|
|
66
85
|
#### Step 3: Activate the Environment
|
86
|
+
|
67
87
|
- On Windows:
|
88
|
+
|
68
89
|
```bash
|
69
90
|
adpsenv\Scripts\activate
|
70
91
|
```
|
71
92
|
|
72
93
|
- On macOS/Linux:
|
94
|
+
|
73
95
|
```bash
|
74
96
|
source adpsenv/bin/activate
|
75
97
|
```
|
76
|
-
|
98
|
+
|
99
|
+
You’ll see the environment name in your terminal prompt
|
100
|
+
indicating the environment is active.
|
77
101
|
|
78
102
|
#### Step 4: Install Dependencies
|
79
103
|
|
@@ -84,44 +108,51 @@ pip install pyadps
|
|
84
108
|
```
|
85
109
|
|
86
110
|
#### Step 5: Deactivate the Environment
|
111
|
+
|
87
112
|
When you’re done working in the environment, deactivate it by running:
|
88
113
|
|
89
114
|
```bash
|
90
115
|
deactivate
|
91
116
|
```
|
92
117
|
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
### 2. Using `conda` (Anaconda/Miniconda):
|
118
|
+
### 2. Using `conda` (Anaconda/Miniconda)
|
97
119
|
|
98
120
|
#### Step 1: Install Conda
|
121
|
+
|
99
122
|
First, you need to have Conda installed on your system. You can either install:
|
100
123
|
|
101
124
|
- [Anaconda (Full Distribution)](https://www.anaconda.com/products/individual)
|
102
125
|
- [Miniconda (Lightweight Version)](https://docs.conda.io/en/latest/miniconda.html)
|
103
126
|
|
104
127
|
#### Step 2: Create a Conda Environment with Python 3.12
|
105
|
-
|
128
|
+
|
129
|
+
Once Conda is installed, open a terminal or command prompt and run
|
130
|
+
the following to create a new environment (replace `adpsenv` with
|
131
|
+
your preferred environment name):
|
106
132
|
|
107
133
|
```bash
|
108
134
|
conda create --name adpsenv python=3.12
|
109
135
|
```
|
110
136
|
|
111
|
-
#### Step 3: Activate the Environment
|
137
|
+
#### Step 3: Activate the Conda Environment
|
138
|
+
|
112
139
|
```bash
|
113
140
|
conda activate adpsenv
|
114
141
|
```
|
115
142
|
|
116
|
-
#### Step 4: Install Dependencies
|
117
|
-
|
143
|
+
#### Step 4: Install pyadps Dependencies
|
144
|
+
|
145
|
+
You can install packages with pip inside Conda environments.
|
146
|
+
|
118
147
|
```bash
|
119
148
|
pip install pyadps
|
120
149
|
```
|
121
150
|
|
122
|
-
#### Step 5: Deactivate the Environment
|
123
|
-
|
124
|
-
|
151
|
+
#### Step 5: Deactivate the Conda Environment
|
152
|
+
|
153
|
+
When done working in the environment, deactivate the environment by running:
|
154
|
+
|
155
|
+
```bash
|
125
156
|
conda deactivate
|
126
157
|
```
|
127
158
|
|
@@ -130,11 +161,11 @@ conda deactivate
|
|
130
161
|
### Streamlit web interface
|
131
162
|
|
132
163
|
Open a terminal or command prompt, activate the environment, and run the command.
|
164
|
+
|
133
165
|
```bash
|
134
166
|
run-pyadps
|
135
167
|
```
|
136
168
|
|
137
|
-
|
138
169
|
## License
|
139
170
|
|
140
171
|
This project is licensed under the MIT License. See the LICENSE file for details.
|
@@ -1,8 +1,20 @@
|
|
1
1
|
# pyadps
|
2
2
|
|
3
|
-
`pyadps` is a Python package for processing moored Acoustic Doppler
|
4
|
-
|
5
|
-
|
3
|
+
`pyadps` is a Python package for processing moored Acoustic Doppler
|
4
|
+
Current Profiler (ADCP) data. It provides various functionalities
|
5
|
+
such as data reading, quality control tests, NetCDF file creation,
|
6
|
+
and visualization.
|
7
|
+
|
8
|
+
This software offers both a graphical interface (`Streamlit`) for
|
9
|
+
those new to Python and direct Python package access for experienced
|
10
|
+
users. Please note that `pyadps` is primarily designed for Teledyne
|
11
|
+
RDI workhorse ADCPs. Other company's ADCP files are not compatible,
|
12
|
+
and while some other RDI models may work, they might require additional
|
13
|
+
considerations.
|
14
|
+
|
15
|
+
- Documentation: <https://pyadps.readthedocs.io>
|
16
|
+
- Source code: <https://github.com/p-amol/pyadps>
|
17
|
+
- Bug reports: <https://github.com/p-amol/pyadps/issues>
|
6
18
|
|
7
19
|
## Table of Contents
|
8
20
|
|
@@ -12,37 +24,49 @@ This software offers both a graphical interface (`Streamlit`) for those new to P
|
|
12
24
|
|
13
25
|
## Installation
|
14
26
|
|
15
|
-
We recommend installing the package within a virtual environment.
|
16
|
-
|
27
|
+
We recommend installing the package within a virtual environment.
|
28
|
+
At present, the package is compatible exclusively with Python version 3.12.
|
29
|
+
You can create a Python environment using tools like `venv` or `conda`.
|
30
|
+
Below are instructions for both methods.
|
17
31
|
|
18
32
|
### 1. Using `venv` (Built-in Python Tool)
|
19
33
|
|
20
34
|
#### Step 1: Install Python version 3.12 (if not already installed)
|
35
|
+
|
21
36
|
Ensure you have Python installed. You can download the latest version from [python.org](https://www.python.org/downloads/).
|
22
37
|
|
23
|
-
#### Step 2: Create a Virtual Environment
|
38
|
+
#### Step 2: Create a Virtual Environment
|
39
|
+
|
24
40
|
- Open your terminal or command prompt.
|
25
41
|
- Navigate to your project folder:
|
42
|
+
|
26
43
|
```bash
|
27
44
|
cd /path/to/your/project
|
28
45
|
```
|
29
|
-
|
46
|
+
|
47
|
+
- Run the following command to create a virtual environment
|
48
|
+
(replace adpsenv with your preferred environment name):
|
30
49
|
|
31
50
|
```bash
|
32
51
|
python -m venv adpsenv
|
33
52
|
```
|
34
53
|
|
35
54
|
#### Step 3: Activate the Environment
|
55
|
+
|
36
56
|
- On Windows:
|
57
|
+
|
37
58
|
```bash
|
38
59
|
adpsenv\Scripts\activate
|
39
60
|
```
|
40
61
|
|
41
62
|
- On macOS/Linux:
|
63
|
+
|
42
64
|
```bash
|
43
65
|
source adpsenv/bin/activate
|
44
66
|
```
|
45
|
-
|
67
|
+
|
68
|
+
You’ll see the environment name in your terminal prompt
|
69
|
+
indicating the environment is active.
|
46
70
|
|
47
71
|
#### Step 4: Install Dependencies
|
48
72
|
|
@@ -53,44 +77,51 @@ pip install pyadps
|
|
53
77
|
```
|
54
78
|
|
55
79
|
#### Step 5: Deactivate the Environment
|
80
|
+
|
56
81
|
When you’re done working in the environment, deactivate it by running:
|
57
82
|
|
58
83
|
```bash
|
59
84
|
deactivate
|
60
85
|
```
|
61
86
|
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
### 2. Using `conda` (Anaconda/Miniconda):
|
87
|
+
### 2. Using `conda` (Anaconda/Miniconda)
|
66
88
|
|
67
89
|
#### Step 1: Install Conda
|
90
|
+
|
68
91
|
First, you need to have Conda installed on your system. You can either install:
|
69
92
|
|
70
93
|
- [Anaconda (Full Distribution)](https://www.anaconda.com/products/individual)
|
71
94
|
- [Miniconda (Lightweight Version)](https://docs.conda.io/en/latest/miniconda.html)
|
72
95
|
|
73
96
|
#### Step 2: Create a Conda Environment with Python 3.12
|
74
|
-
|
97
|
+
|
98
|
+
Once Conda is installed, open a terminal or command prompt and run
|
99
|
+
the following to create a new environment (replace `adpsenv` with
|
100
|
+
your preferred environment name):
|
75
101
|
|
76
102
|
```bash
|
77
103
|
conda create --name adpsenv python=3.12
|
78
104
|
```
|
79
105
|
|
80
|
-
#### Step 3: Activate the Environment
|
106
|
+
#### Step 3: Activate the Conda Environment
|
107
|
+
|
81
108
|
```bash
|
82
109
|
conda activate adpsenv
|
83
110
|
```
|
84
111
|
|
85
|
-
#### Step 4: Install Dependencies
|
86
|
-
|
112
|
+
#### Step 4: Install pyadps Dependencies
|
113
|
+
|
114
|
+
You can install packages with pip inside Conda environments.
|
115
|
+
|
87
116
|
```bash
|
88
117
|
pip install pyadps
|
89
118
|
```
|
90
119
|
|
91
|
-
#### Step 5: Deactivate the Environment
|
92
|
-
|
93
|
-
|
120
|
+
#### Step 5: Deactivate the Conda Environment
|
121
|
+
|
122
|
+
When done working in the environment, deactivate the environment by running:
|
123
|
+
|
124
|
+
```bash
|
94
125
|
conda deactivate
|
95
126
|
```
|
96
127
|
|
@@ -99,11 +130,11 @@ conda deactivate
|
|
99
130
|
### Streamlit web interface
|
100
131
|
|
101
132
|
Open a terminal or command prompt, activate the environment, and run the command.
|
133
|
+
|
102
134
|
```bash
|
103
135
|
run-pyadps
|
104
136
|
```
|
105
137
|
|
106
|
-
|
107
138
|
## License
|
108
139
|
|
109
140
|
This project is licensed under the MIT License. See the LICENSE file for details.
|
@@ -166,6 +166,10 @@ date_df = pd.DataFrame(
|
|
166
166
|
)
|
167
167
|
|
168
168
|
st.session_state.date = pd.to_datetime(date_df)
|
169
|
+
st.session_state.date1 = pd.to_datetime(date_df)
|
170
|
+
st.session_state.date2 = pd.to_datetime(date_df)
|
171
|
+
|
172
|
+
|
169
173
|
|
170
174
|
######### MASK DATA ##############
|
171
175
|
# The velocity data has missing values due to the cutoff
|
@@ -51,9 +51,9 @@ def file_write(path, axis_option, add_attributes=True):
|
|
51
51
|
st.session_state.rawfilename = tempdirname.name + "/rawfile.nc"
|
52
52
|
|
53
53
|
if add_attributes:
|
54
|
-
wr.rawnc(path, st.session_state.rawfilename, st.session_state.
|
54
|
+
wr.rawnc(path, st.session_state.rawfilename, st.session_state.date1, axis_option, attributes=st.session_state.attributes)
|
55
55
|
else:
|
56
|
-
wr.rawnc(path, st.session_state.rawfilename, st.session_state.
|
56
|
+
wr.rawnc(path, st.session_state.rawfilename, st.session_state.date1,axis_option)
|
57
57
|
|
58
58
|
@st.cache_data
|
59
59
|
def file_write_vlead(path, axis_option, add_attributes=True):
|
@@ -61,9 +61,9 @@ def file_write_vlead(path, axis_option, add_attributes=True):
|
|
61
61
|
st.session_state.vleadfilename = tempvardirname.name + "/vlead.nc"
|
62
62
|
|
63
63
|
if add_attributes:
|
64
|
-
wr.vlead_nc(path, st.session_state.vleadfilename, st.session_state.
|
64
|
+
wr.vlead_nc(path, st.session_state.vleadfilename, st.session_state.date2, axis_option, attributes=st.session_state.attributes)
|
65
65
|
else:
|
66
|
-
wr.vlead_nc(path, st.session_state.vleadfilename, st.session_state.
|
66
|
+
wr.vlead_nc(path, st.session_state.vleadfilename, st.session_state.date2, axis_option)
|
67
67
|
|
68
68
|
if "axis_option" not in st.session_state:
|
69
69
|
st.session_state.axis_option = "ensemble" # Default value
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|