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

Make an object-oriented grating model Python package? #1

Open
gully opened this issue Feb 17, 2022 · 1 comment
Open

Make an object-oriented grating model Python package? #1

gully opened this issue Feb 17, 2022 · 1 comment

Comments

@gully
Copy link
Member

gully commented Feb 17, 2022

We have a bunch of useful modeling code spread across over 10 notebooks. The notebooks duplicate lots of code from one to the next and they are getting unwieldy. We want to distill the most useful parts of the package into reusable functions.

We also want a solution where the math notation can be contained alongside the functions, a nice virtue of the notebooks.

I therefore recommend making an object-oriented package with a standalone sphinx website that can auto-render the equations written in docstrings.

I'll plan to set up a proof-of-concept.

@gully
Copy link
Member Author

gully commented Feb 17, 2022

The first commit of this path is here: 5aecdb0

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

No branches or pull requests

1 participant