search

CaltechExperimentalGravity / OptimalBragg

BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

When do we pypi release? #1

Closed pacosalces closed 5 months ago

pacosalces commented 6 months ago

Is this ready? I can install locally, using pip, and run the example scripts but can you?

pacosalces commented 5 months ago

I think we can release now for whoever might be interested in using this package and just keep improving the code. Releasing it will also prompt issues / bugs which are otherwise hidden.

The code has now been "validated" against tmm which is another transfer matrix method for spectral properties. Noise calculations are basically those from pygwinc but modified for nonbinary coatings. Absorption is still the bottleneck in speed, so here maybe we can rethink our implementation but it works for now.

The last critical thing IMO before we release is the name (see related issue)

gautamvenugopalan commented 5 months ago

regarding release, sounds good to me, i can run the example scripts. Thanks @pacosalces for adding the kwargs propagation to the internal functions.

One thing is that our handling of the cost function is still a bit clunky, but I don't know a clean way to allow users to define their own custom cost functions and pass that to the minimizer, but maybe some users will help us develop that.

pacosalces commented 5 months ago

Cool. I've released version 1 on pypi so I'm closing this issue.

I've opened a couple of issues for what may become v2, but now we can share this version and let others find more bugs or suggest enhancements.

@gautamvenugopalan depending on how much time you have, you may want to help release this into conda-forge? I figure it becomes easier once the code is indexed in pypi, but I've just never done it. In any case, regardless of the env manager, if you do as the instructions say (python -m pip install OptimalBragg) you will likely not break anything.