fluid-engine-dev icon indicating copy to clipboard operation
fluid-engine-dev copied to clipboard

Python API and PEP 8

Open doyubkim opened this issue 7 years ago • 13 comments

Current Python API follows corresponding C++ API naming convention which partially breaks PEP 8 (ex. function names). Other frameworks such as TensorFlow for instance, seems to follow language-specific guidelines. That would be ideal for Jet framework as well. However, changing the naming convention will break the API obviously, so it should target for v2.

doyubkim avatar Mar 08 '18 07:03 doyubkim

@utilForever volunteered to work on this issue!

@utilForever, currently dev-v2-gpu is the main dev branch for the v2 release. This contains new C++ APIs (such as new vector/matrix implementations) so it would be great to start from there. You can branch out from dev-v2-gpu and create something like dev-v2-gpu-pep8, make changes, and raise PR against dev-v2-gpu (not the master of course).

doyubkim avatar Oct 07 '18 05:10 doyubkim

@doyubkim Alright. I'll start working today.

utilForever avatar Oct 07 '18 06:10 utilForever

@utilForever Also checking in to see where we're at on this. Thanks again for taking this effort!

doyubkim avatar Oct 17 '18 08:10 doyubkim

@doyubkim Thanks. I'll work on this weekend. Please understand that my health is not very good.

utilForever avatar Oct 18 '18 16:10 utilForever

Same as the other issue: @utilForever I am terribly sorry to hear that :( You should take a good break and not look at any codes. I will take this issue and raise a PR. Please take a good rest and get well soon!

doyubkim avatar Oct 18 '18 17:10 doyubkim

Same as the other issue: @doyubkim Thanks. I'm OK now. So, please take this issue to me. 😄

utilForever avatar Oct 19 '18 04:10 utilForever

@utilForever I am currently working on unifying redundant 2-D and 3-D codes and this will introduce quite a lot of changes in the Python binding lib. If you haven't started working on this issue, I recommend not starting it until the unifying work is completed.

doyubkim avatar Nov 26 '18 03:11 doyubkim

@doyubkim I'm already working on this issue. I'll consider your unifying work. 🎉

utilForever avatar Nov 28 '18 15:11 utilForever

@utilForever the latest dev branch is now merged into the dev-v2-gpu branch. This contains some breaking changes in Python APIs so you may need to adapt to it. What's the latest status of this PEP8 work?

doyubkim avatar Dec 01 '18 09:12 doyubkim

@doyubkim I'm now finished with exception of some grids. However, I'm working on changing the structure from 3 days ago.

utilForever avatar Dec 01 '18 09:12 utilForever

@utilForever thanks for the update!

doyubkim avatar Dec 01 '18 09:12 doyubkim

@doyubkim Update: My work is almost finished. Can I do a pull request to dev-v2-gpu branch?

utilForever avatar Jan 21 '19 17:01 utilForever

Thanks for the update! Yes, that should be the target branch.

doyubkim avatar Jan 21 '19 18:01 doyubkim