There is a newer version of this record available.

Software Open Access

sherpa/sherpa: Sherpa 4.13.1

Doug Burke; Omar Laurino; wmclaugh; dtnguyen2; Marie-Terrell; Hans Moritz Günther; Aneta Siemiginowska; Jamie Budynkiewicz; Tom Aldcroft; Christoph Deil; Brigitta Sipőcz; Johannes Buchner; Iva Laginja; Katrin Leinweber; nplee; Todd


JSON Export

{
  "files": [
    {
      "links": {
        "self": "https://zenodo.org/api/files/90537729-c09b-42b4-bf4f-37deee7d0fad/sherpa/sherpa-4.13.1.zip"
      }, 
      "checksum": "md5:38abea589e6dfdee6166afbf39c78122", 
      "bucket": "90537729-c09b-42b4-bf4f-37deee7d0fad", 
      "key": "sherpa/sherpa-4.13.1.zip", 
      "type": "zip", 
      "size": 15018328
    }
  ], 
  "owners": [
    87064
  ], 
  "doi": "10.5281/zenodo.4770623", 
  "stats": {
    "version_unique_downloads": 91.0, 
    "unique_views": 85.0, 
    "views": 102.0, 
    "version_views": 2737.0, 
    "unique_downloads": 6.0, 
    "version_unique_views": 2156.0, 
    "volume": 90109968.0, 
    "version_downloads": 127.0, 
    "downloads": 6.0, 
    "version_volume": 1620222673.0
  }, 
  "links": {
    "doi": "https://doi.org/10.5281/zenodo.4770623", 
    "conceptdoi": "https://doi.org/10.5281/zenodo.593753", 
    "bucket": "https://zenodo.org/api/files/90537729-c09b-42b4-bf4f-37deee7d0fad", 
    "conceptbadge": "https://zenodo.org/badge/doi/10.5281/zenodo.593753.svg", 
    "html": "https://zenodo.org/record/4770623", 
    "latest_html": "https://zenodo.org/record/6567264", 
    "badge": "https://zenodo.org/badge/doi/10.5281/zenodo.4770623.svg", 
    "latest": "https://zenodo.org/api/records/6567264"
  }, 
  "conceptdoi": "10.5281/zenodo.593753", 
  "created": "2021-05-18T16:21:10.327010+00:00", 
  "updated": "2022-05-20T16:14:35.877113+00:00", 
  "conceptrecid": "593753", 
  "revision": 5, 
  "id": 4770623, 
  "metadata": {
    "access_right_category": "success", 
    "doi": "10.5281/zenodo.4770623", 
    "description": "Sherpa 4.13.1\n<p>This release of Sherpa includes various documentation updates,  bug fixes, and infrastructure changes. The default branch in github has been migrated from master to main.</p>\n<ul>\n<li>documentation changes:<ul>\n<li>updates to documentation for TableModel, Notice2D, cache support for evaluating models, and low level optimization code</li>\n<li>jupyter notebook uopdates </li>\n</ul>\n</li>\n<li>Infrastructure Changes:<ul>\n<li>the master branch has been migrated from master to main</li>\n<li>updates to support numpy 1.20</li>\n<li>updates to support astropy 4.2.1</li>\n<li>updates to support matplotlib 3.4</li>\n<li>test infrastructure clean up and updates</li>\n</ul>\n</li>\n<li>bug fixes:<ul>\n<li>fix an issue with cache evaluation on 1D models using integrated bins</li>\n<li>fix for aarch64 build issue</li>\n<li>fix to sherpa citation command</li>\n<li>fix to honor clearwindow setting for plot_source</li>\n<li>fix errors from save_data when the output file exists</li>\n<li>fix build issues using gcc 7.3 with -Werror=format-security compilation flag</li>\n<li>fix for reg_proj and reg_unc erroring out when the min or max arguments are tuples rather than lists</li>\n</ul>\n</li>\n</ul>\nDetails\n754 - sample_flux now returns statistic values for each row\n<pre><code>The sample_flux command now returns a statistic value for each iteration, \neven if those rows are not used in the reported flux distribution. Fixes #751.\n</code></pre>\n769 - add basic cache tracking\n<pre><code>Adds the cache_status and cache_clear methods to models for verifying the \ncache behavior (this is only expected to be used in rare cases). The cache \ncode has seen documentation improvements.\n</code></pre>\n946 - rework stats tests\n<pre><code>Update the stats tests to use pytest.\n</code></pre>\n960 - Fix model evaluation when changing the integrate setting (fix #958)\n<pre><code>Fixes an issue with cache evaluation on 1D models using integrated bins and \nthe user has changed the integrate setting of the model.\n</code></pre>\n978 - Use C99 def for INFINITY, NAN, isfinite and isnan to build on aarch64 (fix issue #970)\n<pre><code>Use the math constants (IFINITIY, NAN) and funcs (isfinite, isnan, signbit) \nfrom a C99 compliant compiler if the compiler option -std=c99 or greater is \nused, otherwise use the quantities as defined by the library.\n</code></pre>\n991 - lint changes\n<pre><code>Applies a number of flake8-reported warnings to the code base (e.g. excessive \nor missing spaces and new lines).\n</code></pre>\n1000 - Improve sherpa.citation (fix #994 #987)\n<pre><code>Fixes the sherpa.citation() command with its default argument (issue #994) and \nadds release 4.12.2 to the hard-coded list of releases. A typo in a warning \nmessage was fixed (#987).\n</code></pre>\n1001 - Allow command-line arguments for sherpa_test\n<pre><code>Allow command-line arguments to be passed to the sherpa_test script. This allows \nrunning optional tests (e.g. the --runzenodo argument) and to configure the \npytest configuration (e.g. to run coverage checks with --cov sherpa).\n</code></pre>\n1002 - Fix error with clobber=False for paging - issue #996\n<pre><code>Fix an error with clobber=False when the output file exists for several paging \ncommands (e.g. show_data and sherpa.citation). Instead of getting a Sherpa IOErr \nbeing raised a NameError was being raised.\n</code></pre>\n1003 - Fix serialization of iter method data - issue #997\n<pre><code>If set_iter_fit_method has been called with a value other than 'none' then the \noutput of save_all would be incorrect for the options for the iter-fit method.\n</code></pre>\n1004-  flake8 F811 - fix repeated test names\n<pre><code>Clean up of several test files to fix repeated test names.\n</code></pre>\n1005 - Add explicit get/set_datadir routines to sherpa.utils.testing\n<pre><code>Internal changes to how the test data directory location is set and queried, \nincluding removing direct support from SherpaTestCase. Added tests for some \nof this functionality, and updated several test files to remove SherpaTestCase \nor use the new datadir functionality.\n</code></pre>\n1008 - rm warning msgs, fix issue #980\n<pre><code>Fix the compiler warning messages, by defining kwlist to be static const then \nuse the C++ const_cast to remove the const to conform to PyArg_ParseTupleAnd\nKeywords prototype\n</code></pre>\n1012 - Tests: allow test_ui tests to be run with pytest-xdist\n<pre><code>Allow the tests to be run with pytest-xdist.\n</code></pre>\n1016 - Jupyter notebook representation not ideal if model components don't have unique names  - issue: #1013\n<pre><code>Fix an error in the HTML display of a model (used in the notebook) when two \nmodel components have the same name.\n</code></pre>\n1017 - reword remark on normalization of Lorentz function\n<pre><code>Updated the comments pertaining to Lorentz function for clarity\n</code></pre>\n1018 - Fix ShekelModifiedInit missing init par vals\n<pre><code>This PR fixes the missing initial fitted parameter values for the \nShekelModifiedInit function. A fix for issue #1011\n</code></pre>\n1028 - Update region lib code to correct build issues with gcc 7.3.0 compile\n<pre><code>Corrects issue building with gcc 7.3.0+ compilers with the \n-Werror=format-security compilation flag\n</code></pre>\n1034 - Add contextmanager and docs on how to control the output level of sherpa\n<pre><code>Sherpa uses logging for much of its output, this adds a docs and a context \nmanager for controlling the output level for a particular piece of code.\n</code></pre>\n1039 - Add docs for basic.TableModel\n<pre><code>Added missing documentation for TableModel class \n</code></pre>\n1049 - CI: pip submodule test to report coverage\n<pre><code>Report the coverage data from the pip CI run. This only changes the GitHub \nActions runs.\n</code></pre>\n1053 - Release 4.13.0\n<pre><code>Updates to support the 4.13.0 release\n</code></pre>\n1054 - Post 4.13.0 updates\n<pre><code>Updates the Zenodo DOI reference in the README.md to include 4.13.0.\n</code></pre>\n1057 - Fix plot_source clearwindow setting\n<pre><code>The plot_source function was ignoring the clearwindow parameter (always using \nTrue) in calls to plot_source for non-PHA data. This was only for \nsherpa.astro.ui.plot_source (so sherpa.ui.plot_source did not have this problem).\n</code></pre>\n1058 - Store the opstr of model combinations (unary and binary)\n<pre><code>Store the operator string as well as the operator when creating the unary and \nbinary operator expressions for models.\n</code></pre>\n1062 - Minor code cleanup of sherpa.astro.ui.utils\n<pre><code>The sherpa.astro.ui.utils module has seen a number of minor clean-ups, addressing \npylint-reported issues.\n</code></pre>\n1067 - Improve testing of sherpa.astro.ui.utils\n<pre><code>Improve coverage of the sherpa.astro.ui.utils and require pytest 3.9.0 or later \nfor testing Sherpa.\n</code></pre>\n1068 - clean up typos in sherpa/plot code\n<pre><code>Fixed several typos noticed while reviewing plot related fix for #1057\n</code></pre>\n1072 - Update load_data to match load_pha for PHA2 data\n<pre><code>Ensure that load_data behaves like load_pha when given a PHA2 dataset.\n</code></pre>\n1076 - sample_flux now uses the id argument\n<pre><code>The sample_flux routine now uses the id argument rather than always using the \ndata from the default dataset. Fixes #752\n</code></pre>\n1078 - Add error checking for exceptional cases for sample_flux\n<pre><code>Ensure that sample_flux errors out if the Xrays argument is False (as this code \npath is currently broken) or if the confidence argument is invalid.\n</code></pre>\n1082 - Improve documentation for notice2d\n<pre><code>Minor improvements to the documentation of notice2d and ignore2d set of commands. \nFixes #1059\n</code></pre>\n1086 - Use the logging infrastructure for sample_flux output\n<pre><code>The screen output from sample_flux is now generated by the Sherpa logger and \nso can be hidden by the user if required.\n</code></pre>\n1088 - Allow two optimization test to pass\n<pre><code>Address an issue in the optimization tests that meant two tests were failing. \nThis only changes the test code and makes no change to the behavior of the \noptimizers.\n</code></pre>\n1092- Numpy 1.20 warnings\n<pre><code>Avoid test failures due to new warnings added by NumPy 1.20\n</code></pre>\n1094 - Cleanup multi-plot code\n<pre><code>Rework the code that handles the plot_fit_xxx and plot_bkg_fit_xxx calls. \nThere should be no user-visible changes.\n</code></pre>\n1096 - Reduce direct access to plot objects\n<pre><code>Changes to the internals of the plot code, to access information via methods \nrather than direct access, which improves encapsulation and reduces code \nrepetition.\n</code></pre>\n1098 - Bump DS9 version to 8.2 for CI\n<pre><code>Bump DS9 version used in CI tests from 8.1 to 8.2.\n</code></pre>\n1100 - Address reg_proj and reg_unc failures (fix #1093)\n<pre><code>Calls to reg_proj and reg_unc could error out when the min or max arguments \nwere set to tuples rather than lists. The code now converts these attributes \nto lists, which can result in changes to the string output of the objects (use \nof '[]' brackets rather than '()'). Fixes #1093\n</code></pre>\n1101 - Address upper limit issues with sample_flux (fix #457)\n<pre><code>sample_flux no-longer excludes samples at the parameter bounds (soft) when \ncalculating the flux distribution. This could lead to an over-estimation of \nthe flux for upper limits (Fix #457).\n</code></pre>\n1104 - Add basic documentation for the low-level optimization code\n<pre><code>Add and update documentation on the interfaces used by the low-level \noptimization code. Ensure that the plot classes are fully included in the \ndocumentation.\n</code></pre>\n1105 - Consolidate and harmonize the validation of dataset identifiers\n<pre><code>Simplify the code used to validate dataset identifiers. Several names can \nno-longer be used as an identifier ('astrocompmodel', 'astrocompsource', \n'astrodata', 'astromodel', 'astrosource', 'model_component', and \n'source_component') and two can now be used ('energy' and 'photon').\n</code></pre>\n1108 - Read RMFs where N_CHAN is an array\n<pre><code>Allow the pyfits backend to read a wider range of RMF files\n</code></pre>\n1111 - Minor test updates\n<pre><code>Minor updates to the test code, including a small enhancement to the tests run by \nthe smoke_test command.\n</code></pre>\n1112: XSPEC: require model evaluation to be sent low and high grid values\n<pre><code>XSPEC model classes must now be evaluated with bin edges - that is with \nlow,high bins. The support for sending in a single grid and treating it a \nconsecutive set of bins has been marked as deprecated from the model class \ninterface. This feature is still supported for anyone evaluating the models \ndirectly from the sherpa.astro.xspec._xspec module or via the _calc method.\n</code></pre>\n1116: Add parameter-based tests for the PSF model\n<pre><code>Adds several tests of edge-case handling of parameters for PSF convolution models.\n</code></pre>\n1117 - Docs: improve cache discussion and documentation\n<pre><code>Improve the discussion of the cache support when evaluating models.\n</code></pre>\n1120 - Switch default branch to main\n<pre><code>Change the default branch from master to main. Also  includes minor documentation \nupdates (CONTRIBUTING.md updates to switch to main, to reference GitHub Actions \ninstead of Travis, and to remove a note about Python 3.5 support).\n</code></pre>\n1121- Hide AstroPy 4.2.1 FITS-related warnings\n<pre><code>astropy.io.fits.open now creates warning messages about invalid FITS structures \nwhen given a non-FITS file. This updated hides those warning messages since \nroutines such as sherpa.astro.io.load_data attempts to open files (including ascii \nfiles) as FITS. \n</code></pre>\n1122 - Update ds9 download\n<pre><code>Update DS9 tests to use ubuntu18 and darwinhighsierra as ubuntu14 and darwinsierra \nare no longer supported. The DS9 version has been bumped from 8.2 to 8.2.1 as this \nis the latest version.\n</code></pre>\n1125: Support Matplotlib 3.4\n<pre><code>Matplotlib 3.4 changes how the drawstyle argument is handled in some functions. \nThis change removes the use of this argument for those functions.\n</code></pre>\n1126 - Tweak plot docs\n<p>Adds a new notebook that shows off a number of plots created with matplotlib and \n  exports the ScatterPlot, TracePlot, CDFPlot, PDFPlot, and LRHistogram classes from \n  sherpa.plot.</p>\n1130: Fix save_data when the output file exists\n<pre><code>Fix problems when save_data is used with clobber=False but the output file already \nexists. Fixes #1071\n</code></pre>\n1132 - Update XQuartz for GH Actions workflow\n<pre><code>Updates the xQuartz download location and version for the GitHub Actions Conda tests\n</code></pre>\n1139 - Fix typo in Zenodo test that made it fail\n<pre><code>Fixed a typo in the zenodo test which gets only run via the --runzenodo flag \n</code></pre>\n1142 - Add instruction for source build on Mac\n<pre><code>Add instruction for source building on Mac that were previously only part of the \ninternal release notes.\n</code></pre>", 
    "license": {
      "id": "other-open"
    }, 
    "title": "sherpa/sherpa: Sherpa 4.13.1", 
    "relations": {
      "version": [
        {
          "count": 18, 
          "index": 15, 
          "parent": {
            "pid_type": "recid", 
            "pid_value": "593753"
          }, 
          "is_last": false, 
          "last_child": {
            "pid_type": "recid", 
            "pid_value": "6567264"
          }
        }
      ]
    }, 
    "version": "4.13.1", 
    "publication_date": "2021-05-18", 
    "creators": [
      {
        "name": "Doug Burke"
      }, 
      {
        "affiliation": "Smithsonian Astrophysical Observatory", 
        "name": "Omar Laurino"
      }, 
      {
        "name": "wmclaugh"
      }, 
      {
        "name": "dtnguyen2"
      }, 
      {
        "name": "Marie-Terrell"
      }, 
      {
        "affiliation": "MIT", 
        "name": "Hans Moritz G\u00fcnther"
      }, 
      {
        "name": "Aneta Siemiginowska"
      }, 
      {
        "affiliation": "Smithsonian Astrophysical Observatory", 
        "name": "Jamie Budynkiewicz"
      }, 
      {
        "affiliation": "Center for Astrophysics | Harvard & Smithsonian", 
        "name": "Tom Aldcroft"
      }, 
      {
        "affiliation": "HeidelbergCement", 
        "name": "Christoph Deil"
      }, 
      {
        "affiliation": "DIRAC Institute, UW", 
        "name": "Brigitta Sip\u0151cz"
      }, 
      {
        "name": "Johannes Buchner"
      }, 
      {
        "affiliation": "@spacetelescope", 
        "name": "Iva Laginja"
      }, 
      {
        "affiliation": "@gitlabhq", 
        "name": "Katrin Leinweber"
      }, 
      {
        "name": "nplee"
      }, 
      {
        "name": "Todd"
      }
    ], 
    "access_right": "open", 
    "resource_type": {
      "type": "software", 
      "title": "Software"
    }, 
    "related_identifiers": [
      {
        "scheme": "url", 
        "identifier": "https://github.com/sherpa/sherpa/tree/4.13.1", 
        "relation": "isSupplementTo"
      }, 
      {
        "scheme": "doi", 
        "identifier": "10.5281/zenodo.593753", 
        "relation": "isVersionOf"
      }
    ]
  }
}
2,737
127
views
downloads
All versions This version
Views 2,737102
Downloads 1276
Data volume 1.6 GB90.1 MB
Unique views 2,15685
Unique downloads 916

Share

Cite as