summaryrefslogtreecommitdiff
path: root/source/releases.rst
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2016-09-14 13:15:06 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2016-09-14 13:15:06 -0400
commitd4b6cc896441f727ebbaa8acc21d4e70ea4d50e6 (patch)
treecbf3a4c4c3f6d30a71c8dc8ed886d26ab2bba76d /source/releases.rst
parentf2806db64e63eec88310c724615a111c964c671c (diff)
downloadastroconda-d4b6cc896441f727ebbaa8acc21d4e70ea4d50e6.tar.gz
Add "releases" detailing official pipeline installation
Diffstat (limited to 'source/releases.rst')
-rw-r--r--source/releases.rst71
1 files changed, 71 insertions, 0 deletions
diff --git a/source/releases.rst b/source/releases.rst
new file mode 100644
index 0000000..08e007b
--- /dev/null
+++ b/source/releases.rst
@@ -0,0 +1,71 @@
+Pipeline Releases
+=================
+
+.. note::
+
+ - Python 2.x.x is not supported.
+ - 32-bit operating systems are not supported.
+
+
+Installation
+============
+
+To install a STScI pipeline release, use the following format:
+
+.. code-block:: sh
+
+ conda create -n [custom_env_name] --file [URL]
+ source activate [custom_env_name]
+
+
+Example
+-------
+
+.. code-block:: sh
+
+ conda create -n demo_2016.1 \
+ --file http://ssb.stsci.edu/conda/hstdp-2016.1/hstdp-2016.1-linux-py35.2.txt
+ source activate demo_2016.1
+
+The URL used here will not be updated to reflect the latest iteration available. Please consult the :ref:`files` section to ensure you are installing the correct release.
+
+
+.. _files:
+
+File URLs
+=========
+
+Select the URL that matches your intended platform and environment.
+
+HST Data Processing (HSTDP)
+---------------------------
+
+*HSTDP* was previously known as *OPUS*.
+
+2016.1
+++++++
+
+======== ====== ===
+PLATFORM Python URL
+======== ====== ===
+Linux 3.5 http://ssb.stsci.edu/conda/hstdp-2016.1/hstdp-2016.1-linux-py35.2.txt
+OS X 3.5 http://ssb.stsci.edu/conda/hstdp-2016.1/hstdp-2016.1-osx-py35.2.txt
+======== ====== ===
+
+
+Release Schema
+==============
+
+If you wish to write shell scripts to manage your local pipeline installations, this may of interest to you:
+
+.. code-block:: sh
+
+ RELEASE_HOME=http://ssb.stsci.edu/conda
+
+ # hstdp 2016 1
+ # ^ ^ ^
+ RELEASE_PARENT=$NAME-$YEAR.$BUILD
+
+ # linux py35 2
+ # ^ ^ ^
+ RELEASE_CHILD=$RELEASE_PARENT-$PLATFORM-$PYTHON_VERSION.$ITERATION.txt \ No newline at end of file