search

csdms / pymt

A Python toolkit for running and coupling Earth surface models
https://pymt.readthedocs.io
MIT License
52 stars 20 forks source link

Listing pymt components #130

Open gregtucker opened 3 years ago

gregtucker commented 3 years ago

It would be great if pymt users could quickly find out what model and data components are available for pymt. There is a list on the CSDMS wiki website, but it would be helpful to also have:

1) a list of components, with their install commands, on the readthedocs site 2) a way to query a component list from within pymt itself (e.g., pymt.components.list())

mdpiper commented 3 years ago

@gregtucker For item 2, the MODELS attribute provides a list of available pymt components:

>>> import pymt
>>> for model in pymt.MODELS:
...     print(model)
...
Avulsion
Plume
Sedflux3D
Subside
Rafem
FrostNumber
Ku
Hydrotrend
GIPL
ECSimpleSnow
Child
Cem
Waves

This isn't documented, though, which it needs to be.

mcflugen commented 3 years ago

pymt.MODELS contains the models that are currently installed in pymt. However, there may be other models that, while available for pymt, are not yet installed. Is there a way we could give the user the ability to query all of the available pymt models for their platform? Can we do this in a way that we can easily keep up-to-date?