Download Latest Version v0.4.3 source code.tar.gz (2.7 MB)
Email in envelope

Get an email when there's a new version of showyourwork

Home / v0.4.0
Name Modified Size InfoDownloads / Week
Parent folder
README.md 2022-10-21 5.6 kB
0
v0.4.0 source code.tar.gz 2022-10-21 2.7 MB
0
v0.4.0 source code.zip 2022-10-21 2.8 MB
0
Totals: 3 Items   5.5 MB 0

Release Notes

  • Major update to the versioning system for showyourwork articles, and to how dependencies are managed. As of this version, showyourwork no longer manages its own conda environment -- this led to various issues such as inconsistencies in the environment when the version of showyourwork used to launch the workflow differed from the version specified in the workflow.
  • Related to the change above, we no longer require workflows to be executed with the same version of showyourwork that created them. From now on, workflows will be executed with whatever version of showyourwork is installed in the current environment (provided it is >=0.4.0). We are committed to make sure changes to the code are backwards compatible, so the latest version of showyourwork will be able to execute any workflow created with a previous version. This makes it much easier to maintain the workflow, since any issues with the code or any of its dependencies can be resolved by simply upgrading the locally installed version (as opposed to having to patch all previous versions, for example here).
  • The version setting in showyourwork.yml is no longer used (see above); we recommend still including it, however, for bookkeeping purposes.
  • For extended discussions about the above points, please see this issue and the comments in this PR and this PR.
  • showyourwork no longer has explicit non-python dependencies; packages like tectonic are specified within conda environments to specific rules, so non-python dependency management is relagated to snakemake.
  • Now enforcing strict channel provenance in environment.yml files.
  • Upgraded the pinned version of Snakemake to 7.15.2, which fixes several bugs and adds new features (such as this one).
  • Removes showyourwork logo and abstract margin icon in favor of a showyourwork stamp in the upper right hand corner of the first page of the article. This approach is class-independent and fixes several issues with specific classes (such as "Float(s) lost" errors with MNRAS and ARA&A). The positioning and style of the stamp is configurable in showyourwork.yml.
  • Check if figure, abstract defined before redefining them; allows usage of showyourwork with document classes such as article, which don't define an abstract environment.
  • Added GitHub margin links for \variable{} commands.
  • The repository template now includes all available options (set to their default values) in the showyourwork.yml config file.
  • The preprocessing step is now automatically re-run when zenodo.yml changes.
  • Miscellaneous bug fixes, docs improvements, and deprecation warning fixes.

What's Changed

Full Changelog: https://github.com/showyourwork/showyourwork/compare/v0.3.1...v0.4.0

Source: README.md, updated 2022-10-21