forked from pwcazenave/PyFVCOM
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathChangeLog.txt
315 lines (251 loc) · 10.4 KB
/
ChangeLog.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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
1.4.1
-----
Satisfy PyPI packaging rules that mean you can't overwrite an existing
version. So, we have 1.4.1 which is functionally identical to 1.4.0 but with
a different version number.
1.4.0
-----
Add new flag to ncread to provide python datetimes from FVCOM output.
Remove the TAPPY functions and transfer them to the main TAPPY project
(https://gitlab.ecosystem-modelling.pml.ac.uk/pica/tappy or
https://github.com/pwcazenave/tappy/).
read_results:
* ncread has a new optional flag (`datetimes') to convert FVCOM Modified
Julian Days to Python datetime objects. This only occurs if a time
variable (`Times' or `time') has been requested in `vars' or if no
specific variables have been requested (i.e. `vars' is empty).
tide_tools:
* Remove TAPPY and run_TAPPY since those functions now exist in the main
TAPPY project.
1.3.3
-----
More leftover bugs in ncread due to its renaming.
1.3.2
-----
Fix showstopper bug in ncread (due to the rename from readFVCOM to ncread).
Also fix references in the documentation to deprecated function names.
1.3.1
-----
This minor version adds a better error message if TAPPY is not found
(including a link to where to get it).
The bulk of the changes is a correction of the deprecation warnings.
The setup.py also includes a list of dependencies which should be
automatically resolved at installation time.
Specific changes:
grid_tools:
* Update the triangulation tool to the not deprecated version in
matplotlib.
1.3
---
The major aspect of this release is a harmonisation of the naming scheme for
the functions in the toolbox. The new naming more closely follows the PEP8
recommendation of lower case function names (ome old functions used camel
case). The old function names are retained as wrappers around the new
functions with a warning that they are deprecated.
Along the same lines, the redundant FVCOM in the process_FVCOM_results and
read_FVCOM_results files have been removed. Again, the old names exist for
backwards compatibility but will be removed in the future.
This release also removes a (slightly dodgy) function called img2xyz which
attempted to convert an RGB array to xyz data. It was far from perfect, so
it's now gone.
README.md:
* Add the new function names to the README (and add some missing ones).
* Updated with accurate installation instructions (pip vs. setup.py).
* Also updated the version numbers for the dependencies against which
PyFVCOM has been tested.
* The examples section has been removed and a note about the notebooks put
in its place instead.
1.2.1
-----
Fix version number and links in the setup.py.
1.2
---
Since PyFVCOM is on PyPI (and can therefore be installed with pip), the
version scheme has changed from date to major.minor.release.
Rather than bundling TAPPY within this toolbox, this version imports my forked
version of TAPPY, available from:
https://github.com/pwcazenave/tappy
http://gitlab.em.pml.ac.uk/pica/tappy
- The print statements have been replaced by the print function as a move
towards Python 3 compatibility.
- Added a new examples directory with Jupyter (iPython) notebooks of the
examples in the README.
- Update setup.py and add setup.cfg and the MIT licence so PyFVCOM can be
uploaded to PyPI.
Other changes:
grid_tools:
* lineSample can now return the distance along the line (for better
plotting).
process_FVCOM_results:
* Remove unused import.
read_FVCOM_results:
* writeProbes: new function to export data in FVCOM probes format.
tide_tools:
* Move the imports to the top of the file.
* julianDay now better support single values and arrays.
* gregorianDate now also works with single values.
* New wrapper around TAPPy called TAPPY to maintain backwards
compatibility with existing scripts.
20151103
--------
Some new functions (see below) and a general tidy up of the code formatting.
buoy_tools:
* Miscellaneous code clean ups.
cst_tools:
* Miscellaneous code clean ups.
ctd_tools:
* Miscellaneous code clean ups.
current_tools:
* Miscellaneous code clean ups.
* scalar2vector: New function to take a direction and speed and return
the vector components of those values.
* vector2scalar: New function to reverse scalar2vector and return speed
and direction from a given pair of vector components.
grid_tools:
* Miscellaneous code clean ups.
* surrounders: Find the node IDs surrounding a given node.
* heron: New function to calculate the area of a triangle given its corner
coordines.
ll2utm:
* Miscellaneous code clean ups.
ocean_tools:
* Miscellaneous code clean ups.
* dissipation: New function to calculate tidal dissipation for a given
tidal harmonic.
* calculate_rhum: New function to calculate relative humidity from dew
temperature and ambient temperature.
process_FVCOM_results:
* Miscellaneous code clean ups.
read_FVCOM_results:
* Miscellaneous code clean ups.
stats_tools:
* Miscellaneous code clean ups.
* fixRange: New function to scale a set of values between a specified
minimum and maximum.
* rmse: New function to calculate the Root Mean Squared Error of a given
data set.
tappy:
* Miscellaneous code clean ups.
* Don't assume where python lives.
tidal_ellipse:
* Miscellaneous code clean ups.
tide_tools:
* Miscellaneous code clean ups.
* julianDay: Convert the function to use an external library (jdcal)
instead of a slightly fragile and not particularly clean implementation.
* gregorianDate: Use the same jdcal library for the conversion.
README.md:
* Add new dependency (jdcal).
20150122
--------
Add a few new functions, expand some others (maintaining backward
compatibility) and fix some bugs.
cst_tools:
* writeCST: New function to write out a CST file for a given set of arcs.
grid_tools:
* Remove unused import math.
* lineSample: Fix (in a manner of speaking) a bug when creating a transect
through an unstructured grid.
* connectivity: Fix docstring to be correct for one of the outputs.
ocean_tools:
* zbar: Add support for time varying arrays.
* pea: Add support for time varying arrays.
* simpsonhunter: New function to calculate the Simpson-Hunter parameter
for some velocity and depth data.
* mixedlayerdepth: New function to calculate the mixed layer depth (as
defined in ERSEM).
* stokes: Initial attempt at calculating the Stokes number as a predictor
of front locations (in the same vein as simpsonhunter). As yet unfinished
but may be useful to someone as is.
read_FVCOM_results:
* readFVCOM: Add support for exporing the global attributes from a netCDF
file.
* ncwrite: Add function to write netCDF files.
* readProbes: Add support for returning the location of each probe.
tappy:
* Make the code python3 safe.
tide_tools:
* getObservedMetedata: Tidy the docstring.
20140804
--------
Changes since the last release.
buoy_tools:
* Tidy up all the import statements to be at the beginning of the file.
cst_tools:
* Tidy up all the import statements to be at the beginning of the file.
* readCST: Fix the way the end of a vertex is identified to be more
robust.
ctd_tools:
* Tidy up all the import statements to be at the beginning of the file.
grid_tools:
* Tidy up all the import statements to be at the beginning of the file.
* Remove the plotUnstructuredGrid, plotUnstructuredGridProjected and
plotCoast functions as they were pretty basic and only replicated half
a dozen lines of matplotlib which is better demonstrated in the examples
given on the wiki.
ocean_tools:
* pea: new function to calculate the potential energy anomaly from
temperature, salinity and depth.
* zbar: new function to calculate the depth averaged value of an input.
Naive implementation with a loop which can almost certainly be optimised
significantly.
* dens_jackett: add support for arrays of pressure as opposed to single
values.
* _tests: add a test for the conversion from depth to pressure using the
output of the pressure2depth.
process_FVCOM_results:
* Tidy up all the import statements to be at the beginning of the file.
read_FVCOM_results:
* Tidy up all the import statements to be at the beginning of the file.
* elems2nodes: fix the function to support n-dimensional arrays (rather
than being limited to 2D arrays).
stats_tools:
* Tidy up all the import statements to be at the beginning of the file.
tidal_ellipse:
* Tidy up all the import statements to be at the beginning of the file.
tide_tools:
* gregorianDate: fix issue with some month numbers being returned as zero.
README.md
* Remove some old dependencies (mainly to do with the shapefile plotting
routine which has now been removed).
* Also update the list of functions provided by each group of functions.
20140422
--------
Changes since the last release.
buoy_tools:
* getCTDMetadata: read CTD metadata from an SQLite3 data base.
* getCTDData: extract CTD data from an SQLite3 dadta base.
cst_tools:
* readCST: read SMS CST files into a dict for each specified arc.
img2xyz:
* rgb2z: Crude attempt at converting RGB images to depths.
ll2utm:
* Code clean up and ability to work with arrays. Also included some tests
to ensure further changes don't negatively impact on the results.
read_FVCOM_results:
* ncread: wrapper around readFVCOM with a more generic name since the
function is not specific to FVCOM, but works with any netCDF file.
* readProbes: read in FVCOM probes outputs (both 1 and 2D data).
README.md:
* Added new functions to the list of functions.
20140221
--------
grid_tools:
* parseUnstructuredGridGMSH: new function to read GMSH unstructured grids.
* OSGB36toWGS84: new function to convert from British National Grid to
spherical (WGS84).
* connectivity: new function to calculate the connectivity of an
unstructured grid (e.g. find the boundary).
ll2utm:
* Update the function to use arrays of positions rather than single
positions.
* Also add some tests to make sure things don't break with the new
changes.
ocean_tools:
* cond2salt: new function to convert conductivity to salinity (assuming
temperature constant at 25 Celsius).
read_FVCOM_results:
* readFVCOM: update to try aggregating multiple files along a dimension
called 'time' if unsuccessful with the automatic aggregation.
README.md:
* Add example code section for some simple plots.