.. _log:


Change Log
==========

`v2.9.6 <https://github.com/ESGF/esgf-prepare/tree/v2.9.6>`__ (2019-04-01)
--------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.9.5...v2.9.6>`__

**Implemented enhancements:**

-  command to test dataset ID validity
   `#44 <https://github.com/ESGF/esgf-prepare/issues/44>`__

**Closed issues:**

-  reduction of checksumming in esgdrs
   `#57 <https://github.com/ESGF/esgf-prepare/issues/57>`__
-  "esgmapfile show" attempts filesystem writes (and can fail due a to
   race condition)
   `#56 <https://github.com/ESGF/esgf-prepare/issues/56>`__
-  esgdrs failure on non-ascii character in netCDF attribute
   `#55 <https://github.com/ESGF/esgf-prepare/issues/55>`__

`v2.9.5 <https://github.com/ESGF/esgf-prepare/tree/v2.9.5>`__ (2019-01-18)
--------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.9.4...v2.9.5>`__

**Closed issues:**

-  remove unnecessary execute flags
   `#54 <https://github.com/ESGF/esgf-prepare/issues/54>`__
-  requests version
   `#49 <https://github.com/ESGF/esgf-prepare/issues/49>`__

`v2.9.4 <https://github.com/ESGF/esgf-prepare/tree/v2.9.4>`__ (2018-12-18)
--------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.9.3...v2.9.4>`__

**Closed issues:**

-  disable colours option
   `#51 <https://github.com/ESGF/esgf-prepare/issues/51>`__
-  stty errors `#50 <https://github.com/ESGF/esgf-prepare/issues/50>`__

**Merged pull requests:**

-  only run stty if input/output are to a tty [#50]
   `#53 <https://github.com/ESGF/esgf-prepare/pull/53>`__
   (`alaniwi <https://github.com/alaniwi>`__)
-  add --color and --no-color args to commands
   `#52 <https://github.com/ESGF/esgf-prepare/pull/52>`__
   (`alaniwi <https://github.com/alaniwi>`__)

`v2.9.3 <https://github.com/ESGF/esgf-prepare/tree/v2.9.3>`__ (2018-11-09)
--------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.9.2...v2.9.3>`__

**Merged pull requests:**

-  Update requests
   `#48 <https://github.com/ESGF/esgf-prepare/pull/48>`__
   (`sashakames <https://github.com/sashakames>`__)
-  Conda build recipe
   `#46 <https://github.com/ESGF/esgf-prepare/pull/46>`__
   (`sterlingbaldwin <https://github.com/sterlingbaldwin>`__)

`v2.9.2 <https://github.com/ESGF/esgf-prepare/tree/v2.9.2>`__ (2018-09-20)
--------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.9.1...v2.9.2>`__

**Fixed bugs:**

-  esgfetchini doesn't write to /esg/config/esgcet in 2.9.0
   `#39 <https://github.com/ESGF/esgf-prepare/issues/39>`__

**Closed issues:**

-  Conflicting with cdf2cim, when installed second
   `#42 <https://github.com/ESGF/esgf-prepare/issues/42>`__
-  mapfile does not generate with 2.9.0; no error
   `#40 <https://github.com/ESGF/esgf-prepare/issues/40>`__

**Merged pull requests:**

-  KeyError thrown if project doesn't exist in PID\_PREFIXES dictionary
   `#43 <https://github.com/ESGF/esgf-prepare/pull/43>`__
   (`chrisacbr <https://github.com/chrisacbr>`__)
-  fix unwanted characters in ``esgmapfile show --quiet`` output (again)
   `#41 <https://github.com/ESGF/esgf-prepare/pull/41>`__
   (`alaniwi <https://github.com/alaniwi>`__)

`v2.9.1 <https://github.com/ESGF/esgf-prepare/tree/v2.9.1>`__ (2018-08-10)
--------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.9.0...v2.9.1>`__

`v2.9.0 <https://github.com/ESGF/esgf-prepare/tree/v2.9.0>`__ (2018-07-24)
--------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.8.3...v2.9.0>`__

**Closed issues:**

-  in esgmapfile, do not skip "hidden" directories which are part of the
   specified path
   `#37 <https://github.com/ESGF/esgf-prepare/issues/37>`__

`v2.8.3 <https://github.com/ESGF/esgf-prepare/tree/v2.8.3>`__ (2018-06-25)
--------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.8.2...v2.8.3>`__

**Closed issues:**

-  GitHub env variable to release API rate limit
   `#35 <https://github.com/ESGF/esgf-prepare/issues/35>`__
-  Thread error when run occurs in the same directory as the scanned
   directory `#34 <https://github.com/ESGF/esgf-prepare/issues/34>`__
-  GitHubAPIRateLimit hit when testing installation
   `#33 <https://github.com/ESGF/esgf-prepare/issues/33>`__
-  esgdrs: add option to disable checksums
   `#31 <https://github.com/ESGF/esgf-prepare/issues/31>`__
-  esgdrs: use checksums from mapfiles if available
   `#30 <https://github.com/ESGF/esgf-prepare/issues/30>`__
-  esgdrs: only checksum pairs of files with same name
   `#29 <https://github.com/ESGF/esgf-prepare/issues/29>`__
-  Feature request: esgmapfile to use table of checksums
   `#26 <https://github.com/ESGF/esgf-prepare/issues/26>`__

**Merged pull requests:**

-  Various changes re esgfetchtables - details below.
   `#38 <https://github.com/ESGF/esgf-prepare/pull/38>`__
   (`alaniwi <https://github.com/alaniwi>`__)

`v2.8.2 <https://github.com/ESGF/esgf-prepare/tree/v2.8.2>`__ (2018-06-06)
--------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.8.1...v2.8.2>`__

**Closed issues:**

-  Review the args with FileType
   `#27 <https://github.com/ESGF/esgf-prepare/issues/27>`__
-  failure in esgtest\_publish and manual test
   `#25 <https://github.com/ESGF/esgf-prepare/issues/25>`__

**Merged pull requests:**

-  stat outside iterator in checksum
   `#32 <https://github.com/ESGF/esgf-prepare/pull/32>`__
   (`alaniwi <https://github.com/alaniwi>`__)
-  exception handling tweaks
   `#28 <https://github.com/ESGF/esgf-prepare/pull/28>`__
   (`alaniwi <https://github.com/alaniwi>`__)

`v2.8.1 <https://github.com/ESGF/esgf-prepare/tree/v2.8.1>`__ (2018-04-20)
--------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.8.0...v2.8.1>`__

**Closed issues:**

-  failure in esgtest\_publish and manual test
   `#25 <https://github.com/ESGF/esgf-prepare/issues/25>`__
-  temporary files persisted
   `#24 <https://github.com/ESGF/esgf-prepare/issues/24>`__
-  add option to show path of mapfile
   `#19 <https://github.com/ESGF/esgf-prepare/issues/19>`__

`v2.8.0 <https://github.com/ESGF/esgf-prepare/tree/v2.8.0>`__ (2018-04-05)
--------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.7.40...v2.8.0>`__

**Closed issues:**

-  update doc location message
   `#23 <https://github.com/ESGF/esgf-prepare/issues/23>`__

`v2.7.40 <https://github.com/ESGF/esgf-prepare/tree/v2.7.40>`__ (2018-03-14)
----------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.7.39...v2.7.40>`__

**Fixed bugs:**

-  Wrong collector filtering in default mode for mapfile generation
   `#22 <https://github.com/ESGF/esgf-prepare/issues/22>`__

**Closed issues:**

-  Remove files from an input list during DRS migration
   `#21 <https://github.com/ESGF/esgf-prepare/issues/21>`__
-  wrong order of commands in "esgprep drs todo" output when updating
   "latest" symlink
   `#20 <https://github.com/ESGF/esgf-prepare/issues/20>`__

`v2.7.39 <https://github.com/ESGF/esgf-prepare/tree/v2.7.39>`__ (2018-03-09)
----------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.7.39...HEAD>`__

**Fixed bugs:**

-  Wrong collector filtering in default mode for mapfile generation
   `#22 <https://github.com/ESGF/esgf-prepare/issues/22>`__

**Closed issues:**

-  Remove files from an input list during DRS migration
   `#21 <https://github.com/ESGF/esgf-prepare/issues/21>`__
-  wrong order of commands in "esgprep drs todo" output when updating
   "latest" symlink
   `#20 <https://github.com/ESGF/esgf-prepare/issues/20>`__

`v2.7.38 <https://github.com/ESGF/esgf-prepare/tree/v2.7.38>`__ (2018-02-22)
----------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.7.37...v2.7.38>`__

`v2.7.37 <https://github.com/ESGF/esgf-prepare/tree/v2.7.37>`__ (2018-02-14)
----------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.7.36...v2.7.37>`__

`v2.7.36 <https://github.com/ESGF/esgf-prepare/tree/v2.7.36>`__ (2018-02-06)
----------------------------------------------------------------------------

`Full
Changelog <https://github.com/ESGF/esgf-prepare/compare/v2.7.35...v2.7.36>`__

**Closed issues:**

-  Tags missing and issue with publishing CORDEX data
   `#18 <https://github.com/ESGF/esgf-prepare/issues/18>`__
-  --commands-file option is being written to the tree file
   `#17 <https://github.com/ESGF/esgf-prepare/issues/17>`__

`v2.7.35 <https://github.com/ESGF/esgf-prepare/tree/v2.7.35>`__ (2018-02-02)
----------------------------------------------------------------------------

**Closed issues:**

-  dataset\_id names
   `#15 <https://github.com/ESGF/esgf-prepare/issues/15>`__
-  use consistent delete command in "esgprep drs todo"
   `#14 <https://github.com/ESGF/esgf-prepare/issues/14>`__
-  unicode ascii conversion error in "esgprep drs tree"
   `#12 <https://github.com/ESGF/esgf-prepare/issues/12>`__
-  hard coded strings in directory\_format are ignored without warning
   in "esgprep drs"
   `#11 <https://github.com/ESGF/esgf-prepare/issues/11>`__
-  root directory stored in tree file in "esgprep drs"
   `#10 <https://github.com/ESGF/esgf-prepare/issues/10>`__
-  "tree" file breaking logging in "esgprep drs"
   `#9 <https://github.com/ESGF/esgf-prepare/issues/9>`__
-  esgprep fails to install under esgf-installer
   `#8 <https://github.com/ESGF/esgf-prepare/issues/8>`__
-  enhancement: sanity check esg.ini for mistakes
   `#7 <https://github.com/ESGF/esgf-prepare/issues/7>`__
-  UnicodeEncode Error in fetchini/main.py
   `#6 <https://github.com/ESGF/esgf-prepare/issues/6>`__
-  The esg.cmip6.ini file is blank when downloaded.
   `#5 <https://github.com/ESGF/esgf-prepare/issues/5>`__
-  version tagging
   `#4 <https://github.com/ESGF/esgf-prepare/issues/4>`__
-  string facets shouldn't need options
   `#1 <https://github.com/ESGF/esgf-prepare/issues/1>`__

**Merged pull requests:**

-  when max\_threads=1, do not create a thread pool
   `#16 <https://github.com/ESGF/esgf-prepare/pull/16>`__
   (`alaniwi <https://github.com/alaniwi>`__)
-  Changes related to --commands-file
   `#13 <https://github.com/ESGF/esgf-prepare/pull/13>`__
   (`alaniwi <https://github.com/alaniwi>`__)
-  updated pull request to include new commit
   `#2 <https://github.com/ESGF/esgf-prepare/pull/2>`__
   (`alaniwi <https://github.com/alaniwi>`__)

Untagged older changes
----------------------

+------------+---------+-------------------------------------------------------------------------------------+
| Date       | Version | Modifications                                                                       |
+============+=========+=====================================================================================+
| 2017-05-09 | 2.7     | | Major review from Alan Iwi (CEDA).                                                |
|            |         | | MAjor refactoring.                                                                |
|            |         | | Improve logger management.                                                        |
|            |         | | Improve all outputs.                                                              |
|            |         | | Improve file discovery.                                                           |
|            |         | | Remove ``esg.ini`` fetching and ``fetch-ini`` code simplified .                   |
|            |         | | Add ``--set-*``, ``--symlink`` features and ``drs`` result recording.             |
|            |         | | Add ``--no-cleanup`` features to ``mapfile`` command.                             |
|            |         | | Add filters features to ``check-vocab`` and ``mapfile`` commands.                 |
|            |         | | CMIP6 enabled.                                                                    |
+------------+---------+-------------------------------------------------------------------------------------+
| 2016-09-27 | 2.5     | | Improvement of ``fetch-ini`` command to fetch all configuration files.            |
|            |         | | Small refactoring.                                                                |
+------------+---------+-------------------------------------------------------------------------------------+
| 2016-07-22 | 2.4     | | Improvement of ``mapfile`` and ``check-vocab`` commands                           |
|            |         | | according to the 3.0 publisher release.                                           |
+------------+---------+-------------------------------------------------------------------------------------+
| 2016-07-05 | 2.1     | | Add ``-k`` option to ``fetch-ini`` command.                                       |
+------------+---------+-------------------------------------------------------------------------------------+
| 2016-07-01 | 2.0     | | Full rewriting.                                                                   |
|            |         | | Subcommands merging.                                                              |
+------------+---------+-------------------------------------------------------------------------------------+
| 2016-04-27 | 0.8     | | Mapfile management and output writing enhance for user experience.                |
+------------+---------+-------------------------------------------------------------------------------------+
| 2015-10-23 | 0.7     | | Merging ``esgscan_directory`` and ``esg_mapfiles`` features into a single tool.   |
+------------+---------+-------------------------------------------------------------------------------------+
| 2015-07-06 | 0.6     | | Free case project section.                                                        |
|            |         | | Add ``esg_mapfiles_check_vocab`` command-line.                                    |
|            |         | | Raise thread traceback.                                                           |
|            |         | | Add exit status.                                                                  |
|            |         | | Documentation completion.                                                         |
+------------+---------+-------------------------------------------------------------------------------------+
| 2015-07-06 | 0.5.3   | | Add version within master ID                                                      |
|            |         | | according to the 2.0 publisher release.                                           |
+------------+---------+-------------------------------------------------------------------------------------+
| 2015-06-25 | 0.5.2   | | Checksum type support (MD5 or SHA256).                                            |
+------------+---------+-------------------------------------------------------------------------------------+
| 2015-06-16 | 0.5.1   | | PyPi packaging.                                                                   |
+------------+---------+-------------------------------------------------------------------------------------+
| 2015-06-12 | 0.4.1   | | Sphinx documentation rewriting.                                                   |
+------------+---------+-------------------------------------------------------------------------------------+
| 2015-06-09 | 0.4     | | Add Unix wildacards support and ``--latest`` option                               |
|            |         | | to only scan latest versions.                                                     |
+------------+---------+-------------------------------------------------------------------------------------+
| 2015-03-27 | 0.3.1   | | Improve logging.                                                                  |
|            |         | | Includes developer's entry point.                                                 |
+------------+---------+-------------------------------------------------------------------------------------+
| 2015-03-10 | 0.3     | | Add ``--keep-going`` option to skipped unmatching files.                          |
|            |         | | Remove temporary directory in any case.                                           |
+------------+---------+-------------------------------------------------------------------------------------+
| 2015-02-13 | 0.2     | | Refactoring script with PEP008 convention.                                        |
|            |         | | Add configuration file.                                                           |
|            |         | | Add directory as input.                                                           |
+------------+---------+-------------------------------------------------------------------------------------+
| 2014-09-17 | 0.1     | | MD5 checksum compute by OS (Unix Shell) because of                                |
|            |         | | out memory for big data files.                                                    |
+------------+---------+-------------------------------------------------------------------------------------+