v0.3.0 Add mkdocs documentation, improved docstrings, convert output to standard Python data types.

What's Changed

• 7 make nice docs by @tpprytula in #15

  • Improved docstrings of the exposed functions, and turn them into google format

  • Built and deployed Mkdocs website for the project with the documentation, demo notebooks, and a description of the package and the algorithm itself

  • BREAKING CHANGE: as specified by the docstrings in previous versions, the output of create_sn_graph function is now a tuple consisting of:

    • list of tuples of integers for spheres centres coordinates
    • list of tuples of pairs of vertex coordinates for edges
    • optional np.ndarray for sdf_array

    For the most practical uses this change will not break any workflow, as iterating over the new output format goes the same as iterating over the previous one.

Full Changelog: v0.2.0...v0.3.0

0.2.0 CI pipeline, 3D mesh visualisation function, improved volumetric visualisation function, new tests

What's Changed

• Bump h11 from 0.14.0 to 0.16.0 by @dependabot in #12
• 10 add 3d mesh visualisation function and fix the rasterised visualisation by @tpprytula in #11
  • Added a function visualize_3d_graph to visualise 3D graph as a Trimesh scene, which enables interactive 3D visualisation
  • Simplified the code in volumetric visualisation function (draw_sn_graph)
  • BREAKING CHANGE: in function draw_sn_graph the parameter draw_cricles has been removed. The behaviour is now inferred from parameters sdf_array and background_image, which are both now optional
• 6 add ci pipeline by @tpprytula in #13
  • Implemented tests for the visualisation module and fixed some tests for the core module
  • Added status badges in Readme

Full Changelog: 0.1.1...v0.2.0

0.1.1 Enhance readme

What's Changed

• 8 add installation and fix image loading in readme by @tpprytula in #9

• fixed image loading in readme
• added installation manual to readme
• expanded on a basic usage example and added an extra figure

Full Changelog: 0.1.0...0.1.1

0.1.0

What's Changed

• Bump black from 23.12.1 to 24.3.0 by @dependabot in #2
• Bump jinja2 from 3.1.5 to 3.1.6 by @dependabot in #3
• 4 implement the 3d version by @tpprytula in #5

New Contributors

• @dependabot made their first contribution in #2
• @tpprytula made their first contribution in #5

Full Changelog: https://github.com/alexandrainst/sn-graph/commits/0.1.0