diff options
| author | Joseph Hunkeler <jhunkeler@gmail.com> | 2016-04-26 18:43:22 -0400 |
|---|---|---|
| committer | Joseph Hunkeler <jhunkeler@gmail.com> | 2016-04-26 18:43:22 -0400 |
| commit | 1110b2a7530b677687c5ae1e36ad5d8cac10e1e1 (patch) | |
| tree | a88d435e9240ebea1dff211e91305503bb20502f /source/updating.rst | |
| parent | 73c337aca863b41f15211982a8634a4267c9bf7b (diff) | |
| download | astroconda-1110b2a7530b677687c5ae1e36ad5d8cac10e1e1.tar.gz | |
Clarification and rewording of update procedure. Added a footnote for STScI employees.
Diffstat (limited to 'source/updating.rst')
| -rw-r--r-- | source/updating.rst | 32 |
1 files changed, 19 insertions, 13 deletions
diff --git a/source/updating.rst b/source/updating.rst index 39464fa..f897e2c 100644 --- a/source/updating.rst +++ b/source/updating.rst @@ -11,41 +11,42 @@ Updating AstroConda There are few simple ways to update packages obtained from AstroConda: -Method One - Updating the Metapackage -------------------------------------- +Updating the Release +-------------------- .. code-block:: sh - $ conda update -n astroconda astroconda + $ conda update -n astroconda stsci -Updating the ``stsci`` metapackage only effects packages that are part of the **official public release** of our software. -Using this method, packages that are in the AstroConda repository, but not controlled by the ``stsci`` metapackage, -**will not receive updates**. Please use method two below. +This is best used by individuals that favor software stability over receiving the "bleeding edge". Remember, updating the +``stsci`` metapackage only effects packages part of the **official public release** of our software. Packages that are +provided by the AstroConda repository, but are not controlled by the ``stsci`` metapackage **will not receive updates**. +This holds true for all other metapackages as well (e.g. stsci-hst, stsci-jwst, stsci-data-analysis, etc). -Method Two - Updating All Packages ----------------------------------- +Updating All Packages +--------------------- .. code-block:: sh $ conda update -n astroconda --all -This method will update the ``stsci`` metapackage, as well all other packages installed in your enviroment. +This will update the ``stsci`` metapackage, as well all other packages installed in your enviroment. [1]_ -Please keep in mind, this updates **all packages** regardless if they were installed from AstroConda, Continuum, Inc., +This updates **all packages** regardless if they were installed from AstroConda, Continuum, Inc., or other third party repositories defined in ``$HOME/.condarc``. (`ref <http://conda.pydata.org/docs/using/pkgs.html#package-update>`__) -Method Three - Updating Packages Individually ---------------------------------------------- +Updating Packages Individually +------------------------------ .. code-block:: sh $ conda update -n astroconda stsci.tools If you are interested in receiving updates for a particular package, then this method is for you. Be aware that packages -may depend on other packages, so the total list returned by this command will be variable. +may depend on other packages, so the total list of package updates returned by this command will vary. Downgrading Packages @@ -92,3 +93,8 @@ a clear side-effect of this will also be losing the ability to update packages t Although this is not a permanent solution it can prove useful in a bad situation. (`ref <http://conda.pydata.org/docs/faq.html?highlight=pinning#pinning-packages>`__) + + +.. rubric:: Footnotes + +.. [1] (STScI-Specific) "Updating All Packages" now assumes the role of "SSBX" in the AstroConda distribution model.
\ No newline at end of file |