Merge pull request #56 from jzuhone/soxs_read

pyXSIM 4.3.0
jzuhone · Sep 16, 2023 · 307f3d8 · 307f3d8
2 parents 5b58c85 + bc8f832
commit 307f3d8
Show file tree

Hide file tree

Showing 18 changed files with 505 additions and 235 deletions.
diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst
@@ -3,6 +3,33 @@
 ChangeLog
 =========
 
+Version 4.3.0
+-------------
+
+This version of pyXSIM contains new features.
+
+* In conjunction with SOXS 4.6.0, it is now possible to pass an HDF5 events file
+  created by :func:`~pyxsim.photon_list.project_photons` directly to the SOXS
+  instrument simulator for use in event simulation. See :ref:`instr-soxs` for more
+  details.
+* The method :meth:`~pyxsim.sources.SourceModel.make_source_fields` now returns
+  a fourth field, which is the X-ray "count rate" in photons/s. See :ref:`xray-fields`
+  for more details.
+* It is now possible to change the field names supplied by
+  :meth:`~pyxsim.sources.SourceModel.make_source_fields` and
+  :meth:`~pyxsim.sources.SourceModel.make_intensity_fields` if one desires to by
+  supplying a value for the optional ``band_name`` keyword argument. If specified,
+  this argument will replace the ``"{emin}_{emax}_keV`` part of the field name. See
+  :ref:`xray-fields` for more details.
+* Two new convenience methods, :meth:`~pyxsim.sources.SourceModel.make_line_source_fields`
+  and :meth:`~pyxsim.sources.SourceModel.make_line_intensity_fields`, have been
+  added, which create new fields for the line emission from a source. See :ref:`line-fields`
+  for more details.
+* For thermal emission sources, is is now possible to supply a ``min_entropy``
+  parameter, which will set a minimum entropy for the gas cells or particles to
+  be considered in the emission calculation. See :ref:`thermal-sources` for more
+  details.
+
 Version 4.2.1
 -------------
 

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -72,17 +72,17 @@
 
 # General information about the project.
 project = "pyXSIM"
-copyright = "2022, John ZuHone"
+copyright = "2023, John ZuHone"
 author = "John ZuHone"
 
 # 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 = "4.2.1"
+version = "4.3.0"
 # The full version, including alpha/beta/rc tags.
-release = "4.2.1"
+release = "4.3.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/doc/source/cookbook/Advanced_Thermal_Emission.ipynb b/doc/source/cookbook/Advanced_Thermal_Emission.ipynb
@@ -64,9 +64,6 @@
    "execution_count": null,
    "metadata": {
     "collapsed": false,
-    "jupyter": {
-     "outputs_hidden": false
-    },
     "pycharm": {
      "name": "#%%\n"
     }
@@ -111,9 +108,6 @@
    "execution_count": null,
    "metadata": {
     "collapsed": false,
-    "jupyter": {
-     "outputs_hidden": false
-    },
     "pycharm": {
      "name": "#%%\n"
     }
@@ -160,9 +154,6 @@
    "execution_count": null,
    "metadata": {
     "collapsed": false,
-    "jupyter": {
-     "outputs_hidden": false
-    },
     "pycharm": {
      "name": "#%%\n"
     }
@@ -218,9 +209,6 @@
    "execution_count": null,
    "metadata": {
     "collapsed": false,
-    "jupyter": {
-     "outputs_hidden": false
-    },
     "pycharm": {
      "name": "#%% \n"
     }
@@ -250,9 +238,6 @@
    "execution_count": null,
    "metadata": {
     "collapsed": false,
-    "jupyter": {
-     "outputs_hidden": false
-    },
     "pycharm": {
      "name": "#%%\n"
     }
@@ -430,20 +415,6 @@
     "Now that we have a set of \"events\" on the sky, we can read them in and write them to a SIMPUT file:"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   },
-   "outputs": [],
-   "source": [
-    "events = pyxsim.EventList(\"snap_132_events.h5\")\n",
-    "events.write_to_simput(\"snap_132\", overwrite=True)"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {
@@ -452,7 +423,7 @@
     }
    },
    "source": [
-    "We can then use this SIMPUT file as an input to the instrument simulator in SOXS. We'll use a small \n",
+    "Now that we have a set of \"events\" on the sky, we can use them as an input to the instrument simulator in SOXS. We'll use a small \n",
     "exposure time (100 ks instead of 300 ks), and observe it with the as-launched ACIS-I model:"
    ]
   },
@@ -467,7 +438,7 @@
    "outputs": [],
    "source": [
     "soxs.instrument_simulator(\n",
-    "    \"snap_132_simput.fits\",\n",
+    "    \"snap_132_events.h5\",\n",
     "    \"evt.fits\",\n",
     "    (100.0, \"ks\"),\n",
     "    \"chandra_acisi_cy0\",\n",