semvec/pypi-packages huggingface dataset:
pymt-dbseabed 0.1.1
PyMT plugin for dbSEABED datasets.
Keywords: bmi, pymt

=============
pymt_dbseabed
=============


.. image:: https://img.shields.io/badge/CSDMS-Basic%20Model%20Interface-green.svg
        :target: https://bmi.readthedocs.io/
        :alt: Basic Model Interface

.. image:: https://img.shields.io/badge/recipe-pymt_dbseabed-green.svg
        :target: https://anaconda.org/conda-forge/pymt_dbseabed

.. image:: https://readthedocs.org/projects/pymt-dbseabed/badge/?version=latest
        :target: https://pymt-dbseabed.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://img.shields.io/badge/License-MIT-blue.svg
        :target: https://github.com/gantian127/pymt_dbseabed/blob/master/LICENSE


`pymt_dbseabed <https://github.com/gantian127/pymt_dbseabed>`_ is a package that uses
the `bmi_dbseabed <https://github.com/gantian127/bmi_dbseabed>`_ pacakge to convert
`dbSEABED <https://instaar.colorado.edu/~jenkinsc/dbseabed/>`_ datasets into a reusable,
plug-and-play data component for
`PyMT <https://pymt.readthedocs.io/en/latest>`_
modeling framework developed by Community Surface
Dynamics Modeling System (`CSDMS <https://csdms.colorado.edu/wiki/Main_Page>`_).
This allows dbSEABED datasets to be easily coupled with other datasets or
models that expose a Basic Model Interface.

---------------
Installing pymt
---------------

Installing `pymt` from the `conda-forge` channel can be achieved by adding
`conda-forge` to your channels with:

.. code::

  conda config --add channels conda-forge

*Note*: Before installing `pymt`, you may want to create a separate environment
into which to install it. This can be done with,

.. code::

  conda create -n pymt python=3
  conda activate pymt

Once the `conda-forge` channel has been enabled, `pymt` can be installed with:

.. code::

  conda install pymt

It is possible to list all of the versions of `pymt` available on your platform with:

.. code::

  conda search pymt --channel conda-forge

** Please make sure to install python=3.11, model_metadata=v0.7, gimli=v0.2.4, gimli.units=0.3.0. 
Otherwise, you may encounter import error for pymt_dbseabed.

------------------------
Installing pymt_dbseabed
------------------------



To install `pymt_dbseabed`, use pip

.. code::

  pip install pymt_dbseabed

or conda

.. code::

  conda install -c conda-forge pymt_dbseabed


--------------
Coding Example
--------------
You can learn more details about the coding example from the
`tutorial notebook <https://github.com/gantian127/pymt_dbseabed/blob/master/notebooks/pymt_dbseabed.ipynb>`_.


Credits
=======

* Tian Gan <gantian127@gmail.com>


Changelog for pymt_dbseabed
===========================

0.1.1 (2025-03-07)
-------------------
- update package to work for pymt 1.3.2

0.1.0 (2024-04-16)
------------------

- Initial release