lsst / rubin_sim

Scheduler, survey strategy analysis, and other simulation tools for Rubin Observatory.
https://rubin-sim.lsst.io
GNU General Public License v3.0
41 stars 37 forks source link

OPSIM-1079: Update pyproject.toml and workflows #364

Closed rhiannonlynne closed 1 year ago

rhiannonlynne commented 1 year ago

Update pyproject.toml to fix setuptools_scm issue with version.py file update workflows - add ruff workflow, move rubin-sim tests to mamba forge set up for pypi installation of rubin-sim

rhiannonlynne commented 1 year ago

I expect that "Build and Upload Docs" will fail until we move from our current doc setup to the Rubin User Guide setup, but since I was adding other workflows here I just added it anyway. Could pull it out until later. Currently the "Run Tests and Build Documentation" does build and publish the docs, and so the publish docs part of that would go away after the doc update, in favor of the newer Build and Upload docs workflow. Ruff fails because we haven't finished making the files compliant with ruff yet (mostly docstring issues).

rhiannonlynne commented 1 year ago

The "build_pypi" workflow won't be triggered until the PR is merged to main, and won't publish to pypi unless there is a tag.

rhiannonlynne commented 1 year ago

For Eric - I think this would put rubin_sim onto pypi (as rubin-sim or rubin_sim? not sure yet) with dependencies, except that the pyoorb part wouldn't be usable without an additional (only condo-installable) piece of data. I don't think you're using that module though in schedview.

rhiannonlynne commented 1 year ago

Jon had suggested that default values not be stated in the doc string, because you can see the value in the docs in the call. Sometimes this isn't entirely true (like when None triggers a default in the code) but when we can drop them, it makes sense to me.

rhiannonlynne commented 1 year ago

I do seem to have some unit test failures that got triggered by the ruff though, so will fix those.