lacker / seticore

A high-performance implementation of some core SETI algorithms that can be included in other programs.
MIT License
3 stars 7 forks source link

** python SeticorePy package #26

Open radonnachie opened 1 year ago

radonnachie commented 1 year ago

Makes the python code installable 🤷‍♂️ I learnt something doing this.

lacker commented 1 year ago

Interesting. I don't actually know how this stuff works myself but it seems like a reasonable idea. Would this be like, pip install SeticorePy? I feel like the ideal name would just be pip install seticore.

radonnachie commented 1 year ago

Could definitely change the name.

Yeah, I did a local install as it's not published on the python registry, so pip install ./python. It adds the viewer and crosscheck executables to the environment...

radonnachie commented 1 year ago

https://setuptools.pypa.io/en/latest/userguide/entry_point.html if you're curious..

radonnachie commented 7 months ago

Heyo Kevin! I've neatened most of the points of yours up... I'm aiming to have this be as lightweight a package as possible because I'd like for other packages to be able to depend on it to provide only the stamp_capnp and hit_capnp objects..

The viewer.py I rate should be split into some helper functions like read stamps and a separate collection of entrypoints... then again it could just be rebranded as soley an entrypoint seeing as the helper functions are light enough to be duplicated in any dependants.

I've found that one can install this python subdirectory with pip install "git+https://github.com/MydonSolutions/seticore@python/#egg=seticore&subdirectory=python". Ideally I'd see a separate repo for the python package, with a submodule that is only the .capnp files. That submodule would also obviously be used by the C++ repo too, to ensure consistency... that's quite a refactor, so I'll bring it up in another Issue once this is closed.

radonnachie commented 7 months ago

oh... could always look at having this pushed to the PyPI so people can just pip install seticore