search

ronshnapp / MyPTV

MyPTV is an open source library designed for 3D particle Tracking (3D-PTV) measurements
MIT License
37 stars 14 forks source link

Why not post package to pip? #30

Open jgostick opened 2 years ago

jgostick commented 2 years ago

Is there any particular reason that your installation instructions require download source code and running pip? Why not post the package to pip and/or conda-forge?

ronshnapp commented 2 years ago

Hi @jgostick, that's a good comment. I think the difficulty with posting the package is that PTV requires somewhat of a complex process to use, so installing it just to have it as an importable package will not be enough for most of the potential users. On the other hand, when someone downloads the source code from Github, they have also the manual, the example folder, and the workflow script that are supposed to help streamlining the processes so this is the solution we have t the moment. To really solve the issue could be to construct another website with a Wiki, the manual and the downloadable example folder, along with the pip installation posted online. I guess that eventually I will take this next step, but it might take a bit of time, so I'll keep this issue open until we get there.

jgostick commented 2 years ago

I just installed it with pip install -e ., after forking and cloning the repo, and it all went smoothly enough.

For our packages, which also have an examples folder that is not part of the pypi package, we just assume the user will get the code from pypi then refer to the github site for help, and this seems to work well. In fact, we get github actions to generate a fancy website using sphinx (see here), but this takes some effort. If your package becomes popular, then you may want to go for it.

ronshnapp commented 2 years ago

Thanks a lot for the tip, it sounds like a good way to go and the PoreSpy wedsite looks really awesome. I will probably go through with something like that soon enough.