search

cherenkov-plenoscope / merlict_development_kit

Scientific propagation of photons in complex sceneries
GNU General Public License v3.0
0 stars 0 forks source link

First release #38

Open relleums opened 5 years ago

relleums commented 5 years ago

We will have a first 'release' of the merlict-development-kit.

This should contain your most urgent requests which we are busy working on:

I think the python-wrapper will have to wait for the next release.

What version-numbering-sheme shall we use? E.g. 1.0.0? Shall we put the version-number into the C++ code? Or is it fine to have it only in the github-repo? I would prefer it not to be in the code.

relleums commented 5 years ago

Also the one_source.py should be part of the first release.

dneise commented 5 years ago

If you prefer the version not to be in the code, then leave it out. But maybe it would be nice to have a small file called __version__ or VERSION to be in the main folder, which contains the version. This way .. a person who happens to have a tarball or zip of this project, can still see the version.

Once this project includes a setup.py file, and is pip installable, this file can be used by setup.py. This is how it is done e.g. in pyfact. https://github.com/fact-project/pyfact/blob/master/setup.py#L3

But if you do not want the version in the codebase at all, that is also fine I assume

dneise commented 5 years ago

I think the current master fulfills these criteria and could already be the first release. Probably we'd like to streamline the README a little ... at least the stuff I wrote was more for you guys than for real users ... so maybe checking wording again and so on might be in order before releasing.

dneise commented 5 years ago

I think "1.0.0" is perfectly fine.