pastas / pastastore

:spaghetti: :convenience_store: Tools for managing timeseries and Pastas models
https://pastastore.readthedocs.io
MIT License
15 stars 4 forks source link

Improve readme usage section #53

Closed dbrakenhoff closed 1 year ago

dbrakenhoff commented 2 years ago

Currently contains too much technical info about Connectors. Should contain something along these lines:

Gettings started. Define Connector [link to extra info in docs] and PastaStore:

conn = pst.PasConnector("test", "./pastas_db")
pstore = pst.PastaStore(conn.name, conn)

Add head observation time series:

o = pd.read_csv("obs.csv", index_col=[0])
meta = {"x": 100, "y": 200}
pstore.add_oseries(o, "obs1", metadata=meta)
# view oseries metadata with
pstore.oseries

Add stresses time series:

p = pd.read_csv("prec.csv", index_col=[0]
e = pd.read_csv("evap.csv", index_col=[0]
pstore.add_stress(p, "prec1", kind="prec", metadata={"x":110, "y":195}
pstore.add_stress(e, "evap1", kind="evap", metadata={"x":110, "y":195}
# view stresses metadata
pstore.stresses

Create time series models

ml = pstore.create_model("obs1", add_recharge=True)
ml.solve()
pstore.add_model(ml)

Load model from PastaStore:

ml2 = pstore.get_models("obs1")
dbrakenhoff commented 2 years ago

This has been improved on dev, leaving this open until I manage to also implement these improvements in the docs.

dbrakenhoff commented 1 year ago

Closed by #80.