pyoscx / pyodrx

Mozilla Public License 2.0
17 stars 11 forks source link

How best to contribute to this project? #2

Open JimWhiteheadUCSC opened 3 years ago

JimWhiteheadUCSC commented 3 years ago

Hi!

I lead a lab at the Univ. of California, Santa Cruz, where we're doing a procedural road network generation project that makes use of pyodrx. Thank you for creating this project, it has been a huge help for us!!

We're at the point where we're starting to add new functionality to the project (e.g., putting in stop signs and speed markers), and were wondering how you'd like to handle new functionality additions. We'd like to give back to the project, and help it along.

We could just make a pull request and you can accept/reject. That would certainly be best for smaller changes.

But, for bigger changes, like the stop signs, you might already have ideas on how you want these to be implemented, and hence it might make sense to have a conversation first.

Thoughts?

MandolinMicke commented 3 years ago

Hi Jim

Nice to hear that you find it useful!

At the moment we have no real implementation ideas, however the next thing we would like to have implemented is the signals part (speed signs etc.), but we don't know when we will have time to actually do it, so if you want to contribute that's great!

When it comes to implementation wise, just follow the standard that is setup for all the classes with: init - with the the requiered inputs get_attributes - get the attributes of that element getelement - get the xml element (ElementTree) of that specific class add... - if you can add multiple instances of a similar object (like one Signal to Signals)

Then of course follow the documentation standard so pdoc3 can be used to generate the html, and make atleast simple tests for each class to make sure they can generate their xml part (like most of the tests).

If you guys want, we can have a chat some day (we are situated in Sweden so a narrow time slot to fit us both (6PM SWE -> 9AM CA)). It would also be nice to hear how you are using the framework for your project.

//Micke

jakobkaths commented 3 years ago

Hi everybody,

also from my side many thanks for this project! I just created a PullRequest for another change and I was wondering how far along the signal implementation is, as this would also be something on our agenda for introduction here. Let me know if I can be of any help here.

Jakob

mander76 commented 3 years ago

Sadly I haven't had time yet. I have read the parts about the signals in opendrive, and it was quite alot of inputs.. So not a very simple task to make it nice.

JimWhiteheadUCSC commented 3 years ago

Ishaan Paranjape, a PhD student at UC Santa Cruz (cc'ed) has a preliminary signals implementation, and is aiming for submitting a pull request this weekend.

On Fri, Jan 22, 2021 at 4:16 AM mander76 notifications@github.com wrote:

Sadly I haven't had time yet. I have read the parts about the signals in opendrive, and it was quite alot of inputs.. So not a very simple task to make it nice.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/pyoscx/pyodrx/issues/2#issuecomment-765358371, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJT225UMITYZZ6WDZR6P6DS3FUDDANCNFSM4UAFVLTA .

jakobkaths commented 3 years ago

Hi Jim,

that sounds great! I actually started implementing „objects“ and was thinking to create a baseclass for those and the „signals“ as they share many attributes. But we could still consider that once any of the two have a pull request. And yes, they indeed have many attributes, but for a start it works fairly well with a few defaults.

Excited to see this grow!

Jakob

ishaan95 commented 3 years ago

Hello,

I have submitted a pull request for the signals feature. Please let me know if there are any questions or changes to be made.

Thanks, Ishaan

mander76 commented 3 years ago

Now it's merged, thanks @ishaan95 for the additions :)

@jakobkaths , now hopefully you can look into your base class idea.