Skip to content

Latest commit

 

History

History
71 lines (54 loc) · 4.96 KB

CHANGES.md

File metadata and controls

71 lines (54 loc) · 4.96 KB
Raw

AstroCats Release Notes

AstroCats on GitHub

AstroCats maintains a single, primary, active branch: master. We try to follow Semantic Versioning (MAJOR.MINOR.PATCH), where changes to the master branch should generally correspond to changes to (at least) the MINOR version number.

The 'change-log' (below) in this file should summarize all API changes that have effects on individual catalogs.

Contents

Future / To-Do

  • Create a settings/arguments/parameters class which handles storing parameters (instead of just an argparse.Namespace) and has methods for running argparse.
  • Create specific 'tasks' for cloning/pulling input/output repositories.
  • Add to the test task to include coverage of the basic types (e.g. spectrum, etc).
  • Add fuzzy-string logic to command-line arguments
## Versions ##

Current

### v0.3.38 - 2018/06/23 ###
  • Added a new Analysis class in astrocats/catalog/analysis.py.
    • Basic 'count' functionality to report the number of files and tasks in each catalog.
  • Added subcommands for git repositories in astrocats/catalog/catalog.py.
    • The git-push subcommand can now be used to add, commit and push all data files in each data repository. This works in all installed catalogs.
    • git-clone: clone all data repositories included in the repos.json input file. NOTE: the name given in the input file must match the github repository name for this to work. If the directory name should be different from the github url, then it must be added manually.
    • 'git-reset' :
      • git-reset-local: reset the repository to the local HEAD, i.e. it runs git reset --hard in each data repository.
      • git-reset-origin: reset the repository to 'origin/master', i.e. it runs git reset --hard origin/master in each data repository.
    • 'pull' : There is (currently) no pull command. Instead, repositories must be pulled manually, or alternatively the git-reset-[] commands can be used to hard-reset.
    • git-status : print the status of the repo in each directory.
  • Loading cached/archived URLs, and the 'refresh' parameters.
    • A new method Catalog.load_url has been added to take the place of Catalog.load_cached_url and Task.load_archive (both of which should now be considered deprecated), as well as some general functionality that has been written into individual tasks.
    • The following command-line arguments and corresponding parameters have been deprecated: {refresh, refresh-list, refresh-all}
  • astrocats/catalog/entry.py
    • Entry.add_alias [new-function]
      • New method to add aliases to an existing entry after first 'cleaning' the alias name - in the same way as the entry names are cleaned by the containing catalog. In this way, the stored aliases should be guaranteed (in general) to match the corresponding entry names (and naming styles).
    • Entry._get_save_path
      • Method now requires that an output data repository exists for a file to be saved (instead of just saving to the output/ directory itself). New catalogs without output data repos will raise a RuntimeError from here when trying to save.
  • astrocats/catalog/source.py
    • Source.bibcode_from_url [new-function]
      • Function extracts the Bibcode from an ADS-URL if possible.
  • astrocats/catalog/catalog.py
    • Catalog.load_cached_url [DEPRECATED]
      • Replaced by new method load_url
    • Catalog.load_url [new-function]
      • This method will load text data from either a URL or a pre-cached file of the data.
      • The detailed behavior of the method depends on whether the code is being run in archived or update mode, and the settings for the particular task calling the method.
  • astrocats/catalog/task.py
    • Task.load_archive [DEPRECATED]
      • Replaced by functionality in Catalog.load_url.
### v0.2.0 - 2016/07/18 ###
  • The code has been completely restructured from a single import.py script to load and create the supernovae catalog, into two separate packages (and corresponding repositories): astrocatalogs/AstroCats, and the supernova-specific astrocatalogs/Supernovae.
  • This package, astrocats, contains the core machinery for creating any general, astronomical catalog. In particular, the astrocats/catalog directory contains the base set of classes which provide all of the desired functionality.