CHANGELOG.md

CHANGELOG

v0.3.0 - 2024-03-12

🐛 Bug Fixes

• e4457a1 - no additional permissions needed, would need to run on vulnerable: pull_request_target (commit by @athril)
• a8b1754 - code reformatting (commit by @athril)
• 0a419f6 - reformatting back (commit by @athril)

🔧 Chores

• 2cb1b77 - expanding CI by adding coverage report (commit by @athril)
• ff59969 - adding protection for sphinx workflow (commit by @athril)
• 08683bb - an automated pipeline to release new version on Github and PyPI (commit by @athril)
• ee07918 - dynamic versioning of PyPI package with setuptools_scm (commit by @athril)
• 37431b4 - fixing PyPI deployment (commit by @athril)
• b485c9e - removing commented lines (commit by @athril)
• 65e0c75 - limiting scope of Sphinx workflow launch (commit by @athril)
• 676b1f9 - adding CODECOV token to prepare for codecov-action@v4 (currently in beta) (commit by @athril)
• 7341eae - fixing reviewdog permissions (commit by @athril)
• 4119d2e - fixing reviewdog permissions (commit by @athril)
• 2afa0eb - fixing reviewdog permissions (commit by @athril)
• ea66084 - reviewdog permissions (commit by @athril)
• b70d867 - reviewdog permissions (commit by @athril)
• 38cc7c4 - fixing outdated versions of actions (commit by @athril)

[v0.2.0]

✨ New features

• Added O2SparcService service:

  • Introduced a O2SparcSolver class which is the main class for running computational jobs on o²S²PARC. This class holds the following methods:
  • submit_job
  • get_job_progress
  • job_done
  • get_results
  • get_job_log

• Introduced get_solver method to O2SparcService which returns a O2SparcSolver object

• Scaffold Retrieval:

  • Introducing the ability to use sparc.client to retrieve scaffolds or scaffold descriptions.
  • The retrieved scaffold or scaffold description files can now be converted to a commonly used mesh format, such as VTK.
  • Reuse of packages from the mapping tools codebase ensures efficient and standardized mesh conversion.

• MBF Segmentation Export:

  • Added support for exporting MBF Segmentation data to a commonly used mesh format, like VTK.

• Segmentation Data Analysis:

  • New functionality to analyze a given segmentation data file for suitability in the mapping tools fitting workflow, and provide a clear and informative report.

• Updated Documentation:

  • Added the SPARC Python Zinc Client tutorial to reflect the features related to Zinc.

[v0.1.0]

🐛 Bug Fixes

• download multiple files from Pennsieve #12
• pennsieve Download file API #14
• Github action updates: Reviewdog should run whenever a PR is modified after opening #15
• new tutorial in Jupyter Notebook
• README.md update

[v0.0.2]

Alpha2 release of Python Sparc Client.

✨ New features

• Code coverage at 100%
• Sphinx documentation with Github Pages

[v0.0.1]

Alpha release of Python Sparc Client.

✨ New features

• automatic/manual module loading
• ServiceBase class for adding new modules
• Pennsieve module with basic functionalities:
  • listing datasets, files, records
  • downloading files
  • Basic API support (GET/POST)