carleyjmartin
commented
1 year ago This is now it's own repository, you can check it out at https://github.com/SuperDARN/pydarn_plugins Any help required on making your own packages, email me or make an issue on the new repo. Thanks!
Discussion
Topic: How to keep a 'core' pyDARN repository and deal with any additional libraries/modules that users would like to be accessible to the wider community.
Description
I was thinking we can maintain a collection of modules that might not be covered in the pyDARN remit, but are useful to the wider community and can be used as a plug in or extension to pyDARN but does not automatically get installed with pyDARN. This might be useful for the MUSIC code from Scranton, or the recently made issue about ray tracing?
My current idea is that we would create a new repository called pydarn-plugins in the organisation, where our default branch would be a template for people to start from to integrate, which will include an outline for installation and setup scripts. Then they can add their code into the repository on a new branch and then if anyone require the new branch we can set it up so that the users can install the plugins using
pip3 install git+https://github.com/superdarn/pydarn-plugins@new-feature.I have looked into being able to specify you want something extra installing when installing pydarn, but I think this might be the simplest option for maintenance and for users to upload their own projects that plug into pydarn and it all be in one place. I think it would be good to require each plugin to produce documentation for read the docs too - outline can also be included in the template branch.
Please let me know what you think, very happy to hear other options, this is very early days for this project.
Category