Checklist for v1.0 release

[xylar]

To do before the release:

• [x] add following data to public server/repo:
  • [x] observations that only need an acknowledgment: UCAR SST, ERSv4 SST we use for the Nino index, NASA SSS, Argo (both the Scripps and the Roemmich data sets), Trenberth data, AVISO SSH, SOSE, NASA SSMI (sea-ice concentration), NASA IceSat (sea-ice thickness), sea-ice area time series, PIOMAS sea-ice volume time series
  • [x] license information or other terms of use and a bibtex file for each data set #367
  • [x] pre-generated mapping files for the EC60to30v3 and the oRRS30to10 grids
  • [x] the MOC mask files for the EC60to30v3 and the oRRS30to10 grids
• [x] script to download data from public repo (one time donwload for now)
• [x] update documentation and obs database
• [x] MPAS-Analysis support for online MOC
• [x] Plotting of transects #327

[milenaveneziani]

@xylar: thanks for making this list. I am removing the open bullet 'cause I'd be already thrilled if we could complete the first 3 tasks by the release of v1..

Here is an idea about the observations folder: considering that the amount of processed data we will be releasing and the amount of data that users would have to process on their own for v1 is not that large, could we have the observations folder as part of the MPAS-Analysis structure for now? This would save work on figuring out how to get to the public server, and how to retrieve data from it if the data is not locally available.

[xylar]

@milenaveneziani, I'm not sure what you mean by "could we have the observations folder as part of the MPAS-Anlaysis structure for now". If you mean, could we add the observations to the code repo, I think the answer is definitely no. I think we are talking about many GB of data. That's far too large to go directly in the MPAS-Analysis repo. We generally hesitate to put files that are even a few tens of MB in the code repo because it makes the process of checking out, branching and updating the code quite a bit slower. Plus, GitHub simply doesn't allow large files. I definitely think we need a different repo.

[milenaveneziani]

ok, forget what I said above. I am going to use this issue to detail the tasks needed for the release.

[milenaveneziani]

@xylar: I have updated the to-do list above with more details about the observational data sets. I still left a couple of questions open, but mostly it should be OK. Let me know if you have comments or questions.

[xylar]

Okay, I don't plan on making any new pull requests until the v1.0 release. I will make a draft message for the release below.

[xylar]

Draft Release Message

The first official public release!

Major Enhancements

• Add climatology maps for ocean-heat-content anomalies #342
• Add a task to compute climatologies of mixed layer depth and compare with SOSE #353
• Add tasks for plotting velocity magnitude and components against SOSE #355
• Add task to plot Bottom PT, S and PD against Schmidtko et al. (2014) observations #369
• Add script to download obs+mapping+region_mask files from public server #375
• Document all tasks and all sections of config file #397
• Add SOSE potential density task #366
• Add WOCE and SOSE potential temperature and salinity transect tasks #327
• Add a task for plotting geojson transects #368
• Add script to plot online MOC #415

Minor Enhancements

• Update script for SOSE preprocessing #354
• Add a script for generating README and bibtex files for each obs. dataset #367
• Add README.md to the documentation as a quick start guide #373
• Add a publicObs tag to all tasks with obs. on public server #379
• Add autogenerated page for each obs. data set #391
• Add config file to bottom of main webpage #404
• Add new colormaps #410

Minor clean-up

• Update author list #341
• Update example config files for Edison #343
• Change list of ice shelves to a more useful one #346
• Remove unused timeCacheSubdirectory config option #356
• Updates mpas-o_in and mpas-seaice_in names #363
• Remove old QU240 run, add new QU240wLI on edison #374
• Make line colors consistent across plots #378
• Update obs in theta config file #376
• Update many entries in the observation database #387
• Switch scripts that download obs. data to use "requests" package #392
• Update MHT legend text with Trenberth reference #395
• Update default color maps #394
• Add climatologyMapSosePotentialDensity to docs #405
• A general clean-up pull request #408:
  • Fix some missing packages in the README
  • Generalize indexNino34 to be labeled correctly if a user chooses nino3 or nino4 as regions
  • Change temperature to potential temperature in many places
  • Move the obs paths/files from [oceanObservations] and [seaIceObservations] to the individual tasks
  • Removed empty bibtex files from the documentation; don't autogenerate them
  • Moved [regions], [plots] and [html] toward the top of config.default
  • Make the --purge flag only delete directories known to MPAS-Analysis
• Remove "displayToScreen" option #412
• Add enhancements and clean-up SOSE, Schmidtko and geojson tasks #416
• Log task progress to file and instead display progress bar #417

Bug fixes

• Fix bug in importing StringIO #361
• Fix bounds on sea-ice time series from cache file #365
• Fix legend plotting when obs are available #398
• Update all multifile datasets to use ncrcat #411
• Fix file prefix for SOSE climatology task with ref runs #423
• Fix climatology computations with single months #427
• Fix periodic boundary in polar plots of lat/lon data #430

[xylar]

Done!