doc updates for v0.8.0

JarronL · Jan 4, 2019 · 726c301 · 726c301
1 parent 445f3e7
commit 726c301
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 16 deletions.
diff --git a/.rtd-environment.yml b/.rtd-environment.yml
@@ -6,9 +6,9 @@ dependencies:
     - matplotlib>=2.0.2
     - astropy>=3
     - Cython
-    - sphinx-automodapi
     - pip:
         - sphinx>=1.5.1
+        - sphinx-automodapi
         - ipykernel
         - nbsphinx
         - git+https://github.com/spacetelescope/poppy.git#egg=poppy

diff --git a/HISTORY.rst b/HISTORY.rst
@@ -1,20 +1,28 @@
 Revision History
 ================
 
-v0.7.0 (Jan 2019)
+v0.8.0 (Jan 2019)
 -----------------
 
-- Release to work with WebbPSF 0.7.0.
-
-  - Field-dependent WFE
-  - Image plane distortions
-
-- Remove official support for Python 2
+- Release to work with WebbPSF 0.8.0.
+- Phasing out support for Python 2
 - Can use ``jwst_backgrounds`` (not required)
 - Add info on saturation limits in terms of surface brightness 
 - Include option to create grism 2nd order
 - Detector pixel timing bugs
 
+v0.7.0 (Jun 2018)
+-----------------
+
+- Did not make it out of development before WebbPSF 0.8.0 release.
+- Works with WebbPSF 0.7.0.
+
+  - Field-dependent WFE
+  - Image plane distortions
+
+- Implemented ``jwst_backgrounds`` (not required)
+
+
 v0.6.5 (Mar 2018)
 -----------------
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -83,7 +83,7 @@
 
 # General information about the project.
 project = u'pynrc'
-copyright = u'2018, Jarron Leisenring'
+copyright = u'2019, Jarron Leisenring'
 author = u'Jarron Leisenring'
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/docs/index.rst b/docs/index.rst
@@ -16,7 +16,7 @@ coronagraphic imaging, slitless grism spectroscopy, DHS observations,
 and weak lens imaging. All PSFs are generated via WebbPSF 
 (https://webbpsf.readthedocs.io) to reproduce realistic JWST images and spectra.
 
-Developed by Jarron Leisenring and contributors at University of Arizona (2015-18).
+Developed by Jarron Leisenring and contributors at University of Arizona (2015 - 2019).
 
 
 .. toctree::

diff --git a/docs/install_clean.rst b/docs/install_clean.rst
@@ -73,7 +73,7 @@ Installing WebbPSF
 The AstroConda copy of WebbPSF has a ``webbpsf-data`` installation dependency, 
 which we do not want in our slightly customized installation, because the WebbPSF 
 data files get downloaded separately. Instead, we will do this in two parts to 
-first install the rest of the dependencies first, then WebbPSF with the 
+first install the most of the dependencies first, then WebbPSF with the 
 ``--no-deps`` flag::
 
     $ conda install jwxml poppy

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -6,18 +6,22 @@ Installation
 Requirements
 ------------
 
-pyNRC requires Python 2.7+ or 3.5+ along with the following packages:
+pyNRC requires Python 3.5+ along with the following packages:
 
 * Recent version of `NumPy <http://www.numpy.org>`_, 
   `SciPy <https://www.scipy.org>`_,
   and `matplotlib <https://www.matplotlib.org>`_
 * `Astropy <http://www.astropy.org>`_ 2+
 * `pysynphot <https://pysynphot.readthedocs.io>`_ 0.9.7+
-* `WebbPSF <https://webbpsf.readthedocs.io>`_ 0.7.0+ 
+* `WebbPSF <https://webbpsf.readthedocs.io>`_ 0.8.0+ 
   and its dependencies.
+
+**Recommended Python packages**:
+
 * `jwst_backgrounds <https://github.com/spacetelescope/jwst_backgrounds>`_ 1.1.1+
 * `psutil <https://pypi.python.org/pypi/psutil>`_
 
+.. _install_conda:
 
 Installing with conda
 ---------------------
@@ -35,6 +39,9 @@ Installing with conda
 
         $ conda install pynrc
 
+
+.. _install_pip:
+
 Installing with pip
 --------------------
 
@@ -47,6 +54,8 @@ You still must download and install the data files,
 as :ref:`described below <data_install>`.
 
 
+.. _install_dev_version:
+
 Installing from source
 ----------------------
 

diff --git a/docs/license.rst b/docs/license.rst
@@ -7,7 +7,7 @@ License
 
     MIT License
 
-    Copyright (c) 2018, Jarron Leisenring
+    Copyright (c) 2019, Jarron Leisenring
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/install_fresh.txt b/install_fresh.txt
@@ -4,6 +4,10 @@ WebbPSF
 
 1. conda config --append channels http://ssb.stsci.edu/astroconda
 2. conda install pysynphot poppy jwxml pysiaf
+	- pysynphot 0.9.12
+	- poppy 0.8.0
+	- jwxml 0.3.0
+	- pysiaf 0.1.8
 3. conda update scikit-image --no-deps
 4. conda install webbpsf --no-deps
 
@@ -14,3 +18,8 @@ JWST Background
 3. conda install healpy=1.11 --no-deps -c conda-forge
 4. pip install jwst_backgrounds
 
+Sphinx/RTD
+
+1. pip install sphinx_automodapi
+2. conda install sphinx_rtd_theme
+3. conda install nbsphinx
diff --git a/pynrc/version.py b/pynrc/version.py
@@ -2,4 +2,4 @@
 
 __author__  = """Jarron Leisenring"""
 __email__   = 'jarronl@email.arizona.edu'
-__version__ = u'0.7.0dev'
+__version__ = u'0.8.0dev'
diff --git a/setup.py b/setup.py
@@ -135,7 +135,8 @@
     long_description=readme + '\n\n' + history,
 
     # The project's main homepage.
-    url='https://github.com/JarronL/pynrc',
+    #url='https://github.com/JarronL/pynrc',
+    url='https://pynrc.readthedocs.io',
 
     # Author details
     author='Jarron Leisenring',