Skip to content

CHANGELOG.md

Latest commit

 

History

History
737 lines (613 loc) · 48.9 KB

CHANGELOG.md

File metadata and controls

737 lines (613 loc) · 48.9 KB

Version 0.11.2

2026-01-20

Maintenance and bugfix release containing some important fixes regarding flux values.

What's Changed

Bugs fixed

Changes to or addition of Effects

  • PSFs associated to PupilMaskWheel, download from server by @oczoske in AstarVienna#838
  • ReferencePixelBorder newly implemented by @oczoske in AstarVienna#840
  • Interactive updating of SkycalcTERCurve by @oczoske in AstarVienna#853

Dependency Changes

  • Bump the dev-dependencies group with 2 updates by @dependabot[bot] in AstarVienna#831
  • Bump pyyaml from 6.0.2 to 6.0.3 in the main-dependencies group by @dependabot[bot] in AstarVienna#830
  • Bump actions/checkout from 5 to 6 by @dependabot[bot] in AstarVienna#837
  • Bump the dev-dependencies group with 2 updates by @dependabot[bot] in AstarVienna#843
  • Bump fonttools from 4.58.4 to 4.61.0 by @dependabot[bot] in AstarVienna#844
  • Bump urllib3 from 2.5.0 to 2.6.0 by @dependabot[bot] in AstarVienna#849
  • Bump synphot from 1.6.0 to 1.6.1 in the main-dependencies group by @dependabot[bot] in AstarVienna#854
  • Bump the dev-dependencies group with 2 updates by @dependabot[bot] in AstarVienna#855
  • Bump pytest-cov from 6.3.0 to 7.0.0 by @dependabot[bot] in AstarVienna#856
  • Bump urllib3 from 2.6.0 to 2.6.3 by @dependabot[bot] in AstarVienna#858
  • Sync dependencies with ecosystem by @teutoburg in AstarVienna#861
  • Allow Python 3.14, sync dependencies by @teutoburg in AstarVienna#865

Documentation Improvements

  • Fix email domain for Kieran Leschinski by @teutoburg in AstarVienna#857
  • Fix formatting and docstrings, add change messages by @teutoburg in AstarVienna#862

Other Changes

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.11.1...v0.11.2

Version 0.11.1

2025-10-26

What's Changed

API Changes

Bugs fixed

Changes to or addition of Effects

Dependency Changes

Documentation Improvements

  • Fix some docstring formatting, add version info by @teutoburg in AstarVienna#828

Other Changes

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.11.0...v0.11.1

Version 0.11.0

2025-09-21

Large release in preparation of the ScopeSim Workshop happening next week. See below for important changes and deprecations.

Highlights

  • Finally add support for Python 3.13 and Numpy 2.
  • Partially resolve circular dependency between ScopeSim and ScopeSim_Templates
  • Several new effects in preparation for MOSAIC simulations (#796).
  • New and improved plotting methods on some classes for easier and nicer visualisation of results.

What's Changed

Deprecations

Download functionality

  • Deprecate downloading IRDB packages directly from GitHub by @teutoburg in AstarVienna#727

Installing IRDB packages directly from GitHub using download_packages() is deprecated. We're not aware that this functionality saw any significant use by the community. If you do need to install unreleased IRDB packages from the GitHub repository (and you know why you need that!), the same result can be achieved by cloning the repository (or your own fork) and then use sim.link_irdb(<path_to_clone>) to point ScopeSim there. That solution has the added benefit that you can keep thing in sync through git alone, which is more reliable anyway. The relevant functionality will be removed in version 0.12.0, at which point attempting to use download_packages() with a GitHub ref will result in an error.

Passing a list as the first argument to download_example_data() has been deprecated since version 0.8.4 and will now result in a TypeError being raised. This is to catch any remaining uses of the old call signature of this function. From version 0.12.0 onwards, arguments will be silently forwarded to the file retriever, meaning if a list is still passed at that point, it will result in an error further downstream.

Source Fields

  • Deprecate direct attribute access in SourceField by @teutoburg in AstarVienna#733

After the SourceField refactor in version 0.9.0, it was still possible to access any item of the underlying data structur (Table or ImageHDU) directly through the SourceField via a standard dict-like syntax. This was retained for backwards compatibility, because some code still relied on this functionality. It does however have the potential to leade to some hard-to-track bugs and is generally an unclean solution, which is why we have been working behind the scenes to slowly remove all internal code that still uses this feature. Now because this is related to how the Source object might be put together in user code, we're using a more carefuly approach in deprecating this, to avoid breaking existing code for no urgent reason. We're thus activating a PendingDeprecationWarning now, which should give users an advanced warning that we will probably fully deprecate this in the future. If you do encounter this warning, please try to use the .field attribute to explicitly access the underlying data structur before using dict-like lookup on it.

API Changes

Bugs fixed

  • Fix creation of cube source from file name by @teutoburg in AstarVienna#559
  • Fix WCU radiometry by @oczoske in AstarVienna#754
  • Use RegularGridInterpolator for proper extrapolation of small PSF images by @oczoske in AstarVienna#798

Changes to or addition of Effects

  • Functionality for MOSAIC minimum viable product by @oczoske in AstarVienna#796

New Features or Improvements

Dependency Changes

Documentation Improvements

Other Changes

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.10.0...v0.11.0

Version 0.10.0

2025-06-27

Large release before the summer, with many improvements and also breaking changes, please make sure to also update your IRDB packages accordingly!

Highlights

  • Many new features, including the "simplified IFU cube readout" mode.
  • More physical treatment of the "electrons to ADU" process, including different gain values (#604).
  • Extensive refactoring and many many bug fixes.
  • More consistency across different classes with similar attributes.
  • Improved treatment of flux units (still WIP, see #662).
  • Many improvements to visual outputs (especially in notebooks), a few new progress bars in long-running loops.

What's Changed

API Changes

  • Refactor FOV, add BackgroundSourceField by @teutoburg in AstarVienna#610
  • Deprecate FieldOfView.spectra by @teutoburg in AstarVienna#653
  • Deprecate adding a Table directly to an ImagePlane by @teutoburg in AstarVienna#657
  • Implement simplified IFU mode with cube readout by @teutoburg in AstarVienna#654
  • Rename CubeSourceField.wave to .waveset for consistency by @teutoburg in AstarVienna#666
  • Rename SummedExposure ➡️ ExposureIntegration by @oczoske in AstarVienna#701
  • Change .wave to .waveset by @oczoske in AstarVienna#707

Bugs fixed

Changes to or addition of Effects

New Features or Improvements

  • Add zeros_from_header() utils function by @teutoburg in AstarVienna#656
  • Add ._repr_html_() magic method to OpticalTrain for nice notebook display by @teutoburg in AstarVienna#667
  • Add version requirement support for IRDB packages by @teutoburg in AstarVienna#660
  • Use progress bar for spectral traces by @teutoburg in AstarVienna#674
  • More logging and another progress bar by @teutoburg in AstarVienna#697

Dependency Changes

Documentation Improvements

Other Changes

  • Make better use of SourceField in FieldOfView by @teutoburg in AstarVienna#651
  • Remove obsolete FovVolumeList.detector_limits by @teutoburg in AstarVienna#655
  • Add replaceholder workflow by @teutoburg in AstarVienna#688
  • Remove unused private attributes from OpticsManager by @teutoburg in AstarVienna#694
  • Refactor and cleanup in OpticalElement by @teutoburg in AstarVienna#700

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.9.3...v0.10.0

Version 0.9.3

2025-04-25

Addition of average exposure effect by @oczoske in AstarVienna#603, otherwise mostly bugfixes, small quality-of-life improvements and some internal refactoring.

What's Changed

Bugs fixed

  • Fix broken flux scaling for extended sources in spectroscopy by @teutoburg in AstarVienna#638

Changes to or addition of Effects

New Features or Improvements

  • Make setting the inst_pkgs path more convenient by @teutoburg in AstarVienna#627
  • Check if all ref keys are found in spectra by @teutoburg in AstarVienna#633
  • Ignore non-package directories for bug_report by @teutoburg in AstarVienna#631
  • Switch off spammy INFO logs from httpx by @teutoburg in AstarVienna#642

Dependency Changes

  • Bump beautifulsoup to 4.13.3 to get rid of deprecation warning by @teutoburg in AstarVienna#600
  • Disable GitHub-based webtests by default by @teutoburg in AstarVienna#601
  • Bump actions/download-artifact from 4.1.9 to 4.2.1 by @dependabot in AstarVienna#602
  • Bump python-dateutil from 2.8.2 to 2.9.0.post0 by @teutoburg in AstarVienna#628
  • Bump h11 from 0.14.0 to 0.16.0 by @dependabot in AstarVienna#645

Other Changes

  • Remove base class check in Effect.apply_to() by @teutoburg in AstarVienna#620
  • Fixup adding mock path to UserCommands by @teutoburg in AstarVienna#640
  • Fixup adding mock path to UserCommands (again) by @teutoburg in AstarVienna#641
  • Use .to_value(<unit>) instead of .to(<unit>).value by @teutoburg in AstarVienna#643

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.9.2...v0.9.3

Version 0.9.2

2025-03-13

Mainly the inclusion of METIS WCU effects in AstarVienna#494 plus a few bugfixes and quality-of-life improvements.

What's Changed

Bugs fixed

Changes to or addition of Effects

Dependency Changes

Documentation Improvements

Other Changes

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.9.1...v0.9.2

Version 0.9.1

2024-11-26

Many small but important fixes and improvements that were missing in v0.9.0.

What's Changed

Changes to or addition of Effects

New Features or Improvements

Dependency Changes

Documentation Improvements

Other Changes

  • Added source scaling test by @janusbrink in AstarVienna#495
  • Move logging config to separate yaml, configure individual loggers by @teutoburg in AstarVienna#502
  • Ignore strip_cdata warning by lxml, introduced by bs4 by @hugobuddel in AstarVienna#504
  • Fix #490: make rescale_imagehdu more robust against dimension mismatches by @oczoske in AstarVienna#503
  • Make random test deterministic by @hugobuddel in AstarVienna#512
  • Fix two more issues with ScopeSimple by @teutoburg in AstarVienna#514

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.9.0...v0.9.1

Version 0.9.0

2024-11-10

Important

The minimum required Python version for this package is now 3.10 (see Dependency Changes). Python 3.13 is currently not supported as it causes issues on some platforms that are not yet fully understood. We are currently working on fixing 3.13 support.

What's Changed

API Changes

New Features or Improvements

  • Replace NaNs in images, log warning by @teutoburg in AstarVienna#466
  • Make observe work with no source (empty field) by @oczoske in AstarVienna#483
  • Add a new top level to CMDS nested mapping to store current simulation run settings by @teutoburg in AstarVienna#493

Dependency Changes

  • Bump actions/download-artifact from 3 to 4.1.7 in /.github/workflows by @dependabot in AstarVienna#465
  • Drop support for Python 3.9 by @teutoburg in AstarVienna#471
  • Bump some dependency versions by @teutoburg in AstarVienna#472
  • Use sphinx-book-theme for RTD by @teutoburg in AstarVienna#473
  • Bump two dependencies, use tqdm.auto by @teutoburg in AstarVienna#477
  • Bump scipy from 1.11.4 to 1.14.1 and httpx from 0.23.0 to 0.26.0 by @teutoburg in AstarVienna#480
  • Remove skycalc_cli from dependencies by @teutoburg in AstarVienna#481
  • Bump notebook from 7.0.7 to 7.2.2 by @dependabot in AstarVienna#486
  • Limit supported Python version to 3.10 <= x < 3.13 by @teutoburg in AstarVienna#497

Documentation Improvements

  • Update source_from_images.ipynb by @hugobuddel in AstarVienna#469
  • Update example notebook to properly show the same observation by @hugobuddel in AstarVienna#476

Other Changes

  • Add SourceField and subclasses, rework Source by @teutoburg in AstarVienna#405
  • Some small improvement, mostly focused on numpy by @teutoburg in AstarVienna#467
  • Don't fail on symlinks for packages path by @teutoburg in AstarVienna#474
  • Cleanup DataContainer in preparation for Effect refactoring by @teutoburg in AstarVienna#478
  • Fix Poisson NaN bug and clarify by @hugobuddel in AstarVienna#484
  • Source object data scaling fix by @janusbrink in AstarVienna#485
  • Workaround for #491 metadata.requires can return None by @hugobuddel in AstarVienna#492
  • Fixed cdelt calculation when scaling an imageHDU by @janusbrink in AstarVienna#490

New Contributors

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.8.4...v0.9.0

Version 0.8.4

2024-08-29

Last version to support Python 3.9

This includes many small and not-so-small fixes and improvements, which are made available here to Python 3.9, while a few more major changes will be released soon as Version 0.9.0, but without support for Python 3.9.

What's Changed

Changes to or addition of Effects

  • Test all cases of DIT & NDIT vs. exptime and AutoExposure by @teutoburg in AstarVienna#428
  • Avoid in-place operations because of dtype conflicts by @teutoburg in AstarVienna#432
  • Split PSF and Electronic effects into subpackages by @teutoburg in AstarVienna#434
  • Improve SVO filter handling by @teutoburg in AstarVienna#454
  • Added function to round the edges of square PSF kernels by @astronomyk in AstarVienna#459

Dependency Changes

Other Changes

  • Formatting and Refactoring of nghxrg.py by @teutoburg in AstarVienna#431
  • Rename DetectorArray ➡️ DetectorManager plus Docstrings and Refactoring by @teutoburg in AstarVienna#423
  • Enlarge initial Field of View to suppord wide-field imagers by @hugobuddel in AstarVienna#433
  • Fix some exposure things by @hugobuddel in AstarVienna#440
  • Deepcopy readout, to prevent it being overwritten. Closes #439 by @hugobuddel in AstarVienna#441
  • Allow star to be shifted by @hugobuddel in AstarVienna#443
  • Attempt to catch crypto warning by @teutoburg in AstarVienna#444
  • Use new main branch for DevOps workflows by @teutoburg in AstarVienna#448
  • Refactor example_data_utils by @teutoburg in AstarVienna#447
  • Remove unused function return_latest_github_actions_jobs_status() by @teutoburg in AstarVienna#449
  • Remove remaining master references by @teutoburg in AstarVienna#460
  • Add units to DataContainer table directly. by @hugobuddel in AstarVienna#461

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.8.3...v0.8.4

Version 0.8.3

2024-06-02

Mostly a small hotfix to allow chaning of exptime in AutoExposure, plus some housekeeping.

What's Changed

Dependency Changes

Other Changes

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.8.2...v0.8.3

Version 0.8.2

2024-05-14

What's Changed

New Features or Improvements

  • Cap negative values below 0 before quantifying to an unsigned int. by @hugobuddel in AstarVienna#414

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.8.1...v0.8.2

Version 0.8.1

2024-05-13

Small changes required for the first METIS Simulated data release.

What's Changed

New Features or Improvements

  • Do something sensible when a trace falls outside the FoV. by @hugobuddel in AstarVienna#407
  • Fix specref not always an integer by @JenniferKarr in AstarVienna#411

Dependency Changes

Documentation Improvements

New Contributors

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.8.0...v0.8.1

Version 0.8.0

2024-04-15

Many small fixes, some new effects, some important fixes related to coordinates, and lots of cleanup.

What's Changed

API Changes

Changes to or addition of Effects

New Features or Improvements

Dependency Changes

Documentation Improvements

Other Changes

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.7.1...v0.8.0

Version 0.7.1

2023-11-07

Bug fixes and better error report

What's Changed

  • Improve the output of scopsim.bug_report() and automatically log that report when an unhandled error occurs: AstarVienna#287
  • Some bug fixes related to that same bug_report: AstarVienna#290, AstarVienna#291
  • Improve ScopeSim's README file: AstarVienna#294
  • Deal with warnings from the latest Python version 3.12: AstarVienna#289
  • Internally restructure and clean the test suite, make sure individual tests are not influencing each other: AstarVienna#285

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.7.0...v0.7.1

Version 0.7.0

2023-10-18

Off-by-one fix.

What's Changed

  • Fix a long-standing bug regarding the internal implementation of WCS coordinates, which had multiple consequences, see AstarVienna#276 for details.
  • This fix might break some existing codes using work-arounds for the bug described above.

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.6.2...v0.7.0

Version 0.6.2

2023-09-14

Patch with bugfixes and code improvements

What's Changed

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.6.1...v0.6.2

Version 0.6.1

2023-09-06

Patch with visualisation improvements and general refactoring

What's Changed

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.6.0...v0.6.1

Version 0.6.0

2023-07-10

Summer 2023

What's Changed

New Contributors

Full Changelog: https://github.com/AstarVienna/ScopeSim/compare/v0.5.6...v0.6.0

Version 0.5.6

2023-03-13

Hotfix to include minimal set of SVO data

What's Changed

Version 0.5.5

2023-03-08

v0.5.5 is the first release by the 2023 A*Vienna team

What's Changed

Version 0.5.4

2022-10-06

Hotfix for header keyword generators

What's Changed

  • incremental special characters for header keywords changed from §to ++
  • source object function calls are now given their own FITS header keyword FNSRCn (function-call source N) due to astropy not liking the combination of HIERARCH and CONTINUE keywords

Version 0.5.3

2022-09-29

Minor upgrade to Spec modes and to FITS keywords

What's Changed

  • Effect object ExtraFitsKeywords now has the ability to add keywords with incrementing index numbers based on the extension number
  • FOV + FOVManager + FOVVolumes classes now accept aperture_id as an argument
  • ApertureList effects object now has an apply_to function which splits the FOVVolumeList accordingly

Version 0.5.2

2022-08-25

Update of DLC server URL to scopesim.univie.ac.at

What's Changed

  • Updated MANIFEST.in to include all the files needed by the basic_instrument test optical train
  • Small update to allow iterative extension specific FITS header keywords. E.g. EXTNAME = DETn.DATA

Version 0.5.1

2022-07-12

Update of DLC server URL to scopesim.univie.ac.at

What's Changed

  • Changed URL in defaults.yaml file

Version 0.5.0

2022-04-22

IFU Spectroscopy mode for METIS

What's Changed

  • The IFU effects for the METIS LMS mode
  • Effects for including extra FITS keywords for the MICADO-ESO delivery
  • Minor change to the OpticalTrain.readout method to allow custom FITS keywords to be added
  • #-strings for accessing the .meta dict contents of Effect objects
  • added the tests.mocks.basic_instrument package for test purposes
  • refactored package downloading functions in server.database
  • Packages can now be downloaded directly from a git commit
  • new RTDs structure for docs based on ipynb files
  • change to SkyCalcTERCurve to use local files to avoid calling the skycalc server

New Effects:

  • MetisLMSSpectralTraceList(SpectralTraceList)
  • MetisLMSSpectralTrace(SpectralTrace)
  • MetisLMSImageSlicer(ApertureMask)
  • MetisLMSEfficiency(TERCurve)
  • ExtraFitsKeywords(Effect)
  • EffectsMetaKeywords(ExtraFitsKeywords)
  • SourceDescriptionFitsKeywords(ExtraFitsKeywords)
  • SimulationConfigFitsKeywords(ExtraFitsKeywords)
  • SpectralTraceListWheel(Effect)
  • Bias(Effect)

Version 0.4.1rc1

2022-03-25

Updates since METIS science team release

What's Changed

  • DetectorList x(y)_size columns now accept units of pixel and mm
  • warnings and errors now handled using python logging package
  • minor bug fixes

New Effects:

  • TopHatFilterCurve
  • TopHatFilterWheel
  • SpanishVOFilterWheel

Version 0.4.0

2022-03-03

Version released for the METIS science team

What's Changed

  • release of new spectroscopy effect SpectalTraceList
  • moved individual spectral trace code to utils file
  • rewritten FovManager class
  • added make_cube, make_image, make_spectrum to FieldOfView class
  • removed fov_grid from Effects
  • added new detector array z_order section (900-class effects)
  • wavelength-dependent PSF in spectroscopic modes
  • proper handling of cube sources
  • headers for output files