search

CWorthy-ocean / C-Star

C-Star is a python package for setting up and running ocean model simulations, with a particular focus on marine carbon dioxide removal (mCDR) applications.
https://c-star.readthedocs.io
10 stars 4 forks source link

Remove underscores from module name (i.e. `cstar_ocean` -> `cstar`) #47

Closed TomNicholas closed 1 month ago

TomNicholas commented 1 month ago

Supercedes #35, by insteading building on top of #41. (So should not be merged until after #41 is merged)

TomNicholas commented 1 month ago

Still need to update the README.md

TomNicholas commented 1 month ago

This should be good now too.

I wasn't totally sure if we need to change anything else in setup.py but we can worry about that when we actually publish it to PyPI (#48)

dafyddstephenson commented 1 month ago

Thanks @TomNicholas . I think we can keep underscores in module files on grounds of "improves readability" and would be consistent with Case attributes - so if we can move basemodel.py back to base_model.py (to reflect Case.base_model) this can go straight in by the looks.

EDIT: have merged this branch into #43 and applied the name change there instead. Merging.