Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme updates #417

Merged
merged 56 commits into from
May 8, 2024
Merged

Readme updates #417

merged 56 commits into from
May 8, 2024

Conversation

j042
Copy link
Member

@j042 j042 commented Apr 18, 2024

Overview

Updated readme and documentations to give a better overview of this project. I've also included some chores / clean ups here so that examples in readme works as it is.
Changes are:

  • more shortcuts. frequently used / main features are directly accessible at splinepy.*
  • fitting clean up. tries to use less ifs. It seems that there's an issue with approximation
  • microstructure tiles clean up. set some variables as class variable
  • added module functions for tiles - easy access to tiles

Checklists

  • Documentations are up-to-date.
  • Added example(s)
  • Added test(s)

Copy link
Member Author

@j042 j042 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

    @property
    def microtile(self):
        """Microtile that is either a spline, a list of splines, or a class
        that provides a `create_tile` function."""
        if hasattr(self, "_microtile"):
            return self._microtile
        else:
            _log.info("microtile is empty. Please checkout splinepy.microstructure.tiles.show() for predefined tile collections!")
            return None

Copy link
Member

@danielwolff1 danielwolff1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great, I really really like the modified documentation!

I just had a few minor remarks / questions but generally I approve of the changes made here and you can proceed with the merge! 🚀

splinepy/helpme/fit.py Show resolved Hide resolved
splinepy/microstructure/microstructure.py Show resolved Hide resolved
splinepy/microstructure/tiles/ellips_v_oid.py Outdated Show resolved Hide resolved
splinepy/microstructure/tiles/snappy.py Outdated Show resolved Hide resolved
splinepy/microstructure/tiles/tile_base.py Show resolved Hide resolved
@j042
Copy link
Member Author

j042 commented Apr 19, 2024

Todo: background color, in modification plot nr.1 is wrong

splinepy/helpme/fit.py Outdated Show resolved Hide resolved
@j042
Copy link
Member Author

j042 commented Apr 22, 2024

@jzwar @clemens-fricke are you happy with the background?

@j042
Copy link
Member Author

j042 commented Apr 22, 2024

todo: change extract bases' angle

@j042
Copy link
Member Author

j042 commented Apr 23, 2024

todo: add iges

@j042 j042 mentioned this pull request May 3, 2024
@j042 j042 force-pushed the cu-readme branch 4 times, most recently from d9ad532 to 6addec7 Compare May 7, 2024 13:23
@j042 j042 merged commit 0c6658f into main May 8, 2024
21 checks passed
@j042 j042 deleted the cu-readme branch May 8, 2024 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants