Merge pull request #438 from kdere/master

 updated docs for a version 0.15.1 release

Author: kdere

ChiantiPy/version.py

@@ -1,5 +1,5 @@
 '''
 the current version of the ChiantiPy package
 '''
-__version_info__ = ('0','15', '0')
+__version_info__ = ('0','15', '1')
 __version__ = '.'.join(__version_info__)

README

@@ -1,4 +1,4 @@
-# ChiantiPy - Version 0.15.0
+# ChiantiPy - Version 0.15.1
 [![Documentation Status](http://readthedocs.org/projects/chiantipy/badge/?version=latest)](http://chiantipy.readthedocs.io/en/latest/?badge=latest)
 [![Coverage Status](https://coveralls.io/repos/github/chianti-atomic/ChiantiPy/badge.svg?branch=master)](https://coveralls.io/github/chianti-atomic/ChiantiPy?branch=master)
 [![ascl:1308.017](https://img.shields.io/badge/ascl-1308.017-blue.svg?colorB=262255)](http://ascl.net/1308.017)

README.md

@@ -1,4 +1,6 @@
-ChiantiPy - Version 0.12.0
+.. _chiantipy---version-0151:
+
+ChiantiPy - Version 0.15.1
 ==========================
 
 |Documentation Status| |Coverage Status| |ascl:1308.017|
@@ -33,10 +35,12 @@ The following dependencies are required to run ChiantiPy,
 -  `Matplotlib <http://matplotlib.org/>`__
 -  `ipyparallel <https://github.com/ipython/ipyparallel>`__
 
-The following two are extremely useful for running Python programs \*
-`IPython <http://ipython.org>`__ \* `Jupyter <http://jupyter.org/>`__
+The following two are extremely useful for running Python programs
+
+-  `IPython <http://ipython.org>`__
+-  `Jupyter <http://jupyter.org/>`__
 
-Optionally, if you’d like to use the GUI dialogs,
+Optionally, if you'd like to use the GUI dialogs,
 
 -  `PyQt5 <https://riverbankcomputing.com/software/pyqt/intro>`__
 
@@ -45,16 +49,18 @@ dependencies, we recommend the `Anaconda
 platform <https://www.continuum.io/downloads>`__. Next, download the
 `CHIANTI
 database <http://www.chiantidatabase.org/chianti_download.html>`__,
-version 10.0 or later. Assuming you’ve placed the CHIANTI tree in
+version 10.0 or later. Assuming you've placed the CHIANTI tree in
 ``$HOME``, set the environment variable in your ``.bashrc`` file,
 
-.. code:: shell
+.. code:: Shell
+
+   export XUVTOP=$HOME/MY_CHIANTI_DIRECTORY
 
-   export XUVTOP=$HOME/chianti/dbase
+should point to the top directory of your CHIANTI distribution
 
 Finally, clone and install the source from GitHub,
 
-.. code:: shell
+.. code:: Shell
 
    $ git clone --recursive https://github.com/chianti-atomic/ChiantiPy.git
    $ cd ChiantiPy
@@ -66,11 +72,11 @@ The release is also available on
 Usage
 -----
 
-As a quick example, we’ll calculate the populations of the top 10 levels
+As a quick example, we'll calculate the populations of the top 10 levels
 of Fe XIV as a function of temperature at constant density and plot
 them:
 
-.. code:: python
+.. code:: Python
 
    >>> import ChiantiPy.core as ch
    >>> import numpy as np

README.rst

@@ -2,6 +2,14 @@
 Changelog
 ===========
 
+Changes from 0.15.0 to 0.15.1
+=============================
+
+The continuum.freeBound method has been corrected so that it can be used under extreme conditions and not fail.
+
+The io.abundanceRead method has been updated to work with new files in the upcoming CHIANTI 10.1 release
+
+
 Changes from 0.14.1 to 0.15.0
 =============================
 

docs/source/changelog.rst

@@ -59,17 +59,17 @@
 
 # General information about the project.
 project = 'ChiantiPy'
-copyright = '2022, Ken Dere'
+copyright = '2023, Ken Dere'
 author = 'Ken Dere'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.15.0'
+version = '0.15.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.15.0'
+release = '0.15.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/conf.py

@@ -56,7 +56,7 @@ The gzipped *data* tar ball can be downloaded from the CHIANTI website_
 
 ::
 
-  setenv XUVTOP /data1/xuv/directory.where.the.tarball.was.placed
+  setenv XUVTOP /data1/directory.where.the.tarball.was.placed
 
 
 or on Windows:   To set the environment variable, go to Control Panel -> System -> Advanced System Properties -> Environment Variables.

docs/source/getting_started.rst

@@ -8,9 +8,9 @@ ChiantiPy Documentation
 
 Welcome to the ChiantiPy documentation. ChiantiPy is a pure Python package for performing calculations of astrophysical spectra using the `CHIANTI atomic database <http://www.chiantidatabase.org/>`_.
 
-The latest version of ChiantiPy is 0.15.0 and is compatible with CHIANTI database version 10.0.X. It is not compatible with previous versions
+The latest version of ChiantiPy is 0.15.1 and is compatible with CHIANTI database version 10.0.X. It is not compatible with previous versions
 
-ChiantiPy v0.15.0 is released under the OSI approved ISC license. From `Wikipedia <https://en.wikipedia.org/w/index.php?title=ISC_license&oldid=664696993>`_: The ISC license is a permissive free software license written by the Internet Software Consortium (ISC). It is functionally equivalent to the simplified BSD and MIT/Expat licenses, ...
+ChiantiPy v0.15.1 is released under the OSI approved ISC license. From `Wikipedia <https://en.wikipedia.org/w/index.php?title=ISC_license&oldid=664696993>`_: The ISC license is a permissive free software license written by the Internet Software Consortium (ISC). It is functionally equivalent to the simplified BSD and MIT/Expat licenses, ...
 
 `CHIANTI <http://www.chiantidatabase.org/>`_ consists of a database of atomic data that can be used to interpret spectral lines and continua emitted from high-temperature, optically-thin astrophysical sources.
 

docs/source/index.rst

@@ -20,7 +20,7 @@ flux
 
 abundfile
 
-    The name of the abundance file.  Acceptable values are any of the file names in XUVTOP/abundance, such as *cosmic_1973_allen*.  The default value is *sun_photospheric_2015_scott* which includes the abundances of Scott et al., 2015, A&A, 573, A25.
+    The name of the abundance file.  Acceptable values are any of the file names in XUVTOP/abundance, such as *cosmic_1973_allen*.  The default value is *sun_photospheric_2015_scott* that includes the abundances of Scott et al., 2015, A&A, 573, A25.
 
 ioneqfile
     the name of the ionization equilibrium file.  Acceptable values are any of the file names in XUVTOP/ioneq such as *arnaud_raymond*, *arnaud_rothenflug*, or *chianti*.  The default value is *chianti* which includes the ionization equilibrium calculations of K.P. Dere, G. Del Zanna, P.R. Young, E. Landi, R Sutherland, 2019, ApJ, 241, 2 and are considered to be based on the best ionization and recombination rates currently available.

docs/source/notes.rst

@@ -10,7 +10,7 @@
     description = 'a Python interface to the CHIANTI atomic database for astrophysical spectroscopy',
     long_description = long_description,
 #    long_description_content_type = text/rst,
-    version = '0.15.0',
+    version = '0.15.1',
     author = 'Ken Dere',
     author_email = '[email protected]',
     url = 'https://github.com/chianti-atomic/ChiantiPy',