=========
pymt_roms
=========
.. 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_roms-green.svg
:target: https://anaconda.org/conda-forge/pymt_roms
.. image:: https://readthedocs.org/projects/pymt-roms/badge/?version=latest
:target: https://pymt-roms.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/License-MIT-blue.svg
:target: hhttps://github.com/gantian127/pymt_roms/blob/master/LICENSE
.. .. image:: https://github.com/gantian127/pymt_roms/actions/workflows/test.yml/badge.svg
:target: https://github.com/gantian127/pymt_roms/actions/workflows/test.yml
.. .. image:: https://github.com/gantian127/pymt_roms/actions/workflows/flake8.yml/badge.svg
:target: https://github.com/gantian127/pymt_roms/actions/workflows/flake8.yml
.. .. image:: https://github.com/gantian127/pymt_roms/actions/workflows/black.yml/badge.svg
:target: https://github.com/gantian127/pymt_roms/actions/workflows/black.yml
pymt_roms is a package that converts `bmi_roms <https://github.com/gantian127/bmi_roms>`_ package into a reusable,
plug-and-play data component for `PyMT <https://pymt.readthedocs.io/en/latest/?badge=latest>`_ modeling framework
developed by Community Surface Dynamics Modeling System (`CSDMS <https://csdms.colorado.edu/wiki/Main_Page>`_).
This allows `ROMS model <https://www.myroms.org/>`_ datasets
to be easily coupled with other datasets or models that expose a `Basic Model Interface <https://bmi.readthedocs.io/en/latest/>`_.
The current implementation supports 2D, 3D and 4D ROMS output datasets defined with geospatial and/or time dimensions (e.g.,
dataset defined with dimensions as [time, s_rho, eta_rho, xi_rho])
========= ===================================
Component PyMT
========= ===================================
Roms `from pymt.models import Roms`
========= ===================================
---------------
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:
Once the environment is activated, `pymt` can be installed with the following command.
Please note that the `pymt_roms` requires the development version of `pymt` (e.g., v1.3.2dev0).
.. code::
pip install git+https://github.com/csdms/pymt.git
.. 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
--------------------
Installing pymt_roms
--------------------
To install `pymt_roms`, use pip
.. code::
pip install pymt_roms
or conda
.. code::
conda install -c conda-forge pymt_roms
--------------------
Coding Example
--------------------
You can learn more details about the coding example from the
`tutorial notebook <https://github.com/gantian127/pymt_roms/blob/master/notebooks/pymt_roms.ipynb>`_.
Credits
=======
* Tian Gan <gantian127@gmail.com>
Changelog for pymt_roms
=======================
0.2.0 (unreleased)
-------------------
0.1.0 (2023-04-04)
------------------
- Initial release
Raw data
{
"_id": null,
"home_page": "https://github.com/gantian127/pymt_roms",
"name": "pymt-roms",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "bmi,pymt",
"author": "Tian Gan",
"author_email": "gantian127@gmail.com",
"download_url": "",
"platform": null,
"description": "=========\npymt_roms\n=========\n\n\n.. image:: https://img.shields.io/badge/CSDMS-Basic%20Model%20Interface-green.svg\n :target: https://bmi.readthedocs.io/\n :alt: Basic Model Interface\n\n.. .. image:: https://img.shields.io/badge/recipe-pymt_roms-green.svg\n :target: https://anaconda.org/conda-forge/pymt_roms\n\n.. image:: https://readthedocs.org/projects/pymt-roms/badge/?version=latest\n :target: https://pymt-roms.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/License-MIT-blue.svg\n :target: hhttps://github.com/gantian127/pymt_roms/blob/master/LICENSE\n\n.. .. image:: https://github.com/gantian127/pymt_roms/actions/workflows/test.yml/badge.svg\n :target: https://github.com/gantian127/pymt_roms/actions/workflows/test.yml\n\n.. .. image:: https://github.com/gantian127/pymt_roms/actions/workflows/flake8.yml/badge.svg\n :target: https://github.com/gantian127/pymt_roms/actions/workflows/flake8.yml\n\n.. .. image:: https://github.com/gantian127/pymt_roms/actions/workflows/black.yml/badge.svg\n :target: https://github.com/gantian127/pymt_roms/actions/workflows/black.yml\n\n\npymt_roms is a package that converts `bmi_roms <https://github.com/gantian127/bmi_roms>`_ package into a reusable,\nplug-and-play data component for `PyMT <https://pymt.readthedocs.io/en/latest/?badge=latest>`_ modeling framework\ndeveloped by Community Surface Dynamics Modeling System (`CSDMS <https://csdms.colorado.edu/wiki/Main_Page>`_).\nThis allows `ROMS model <https://www.myroms.org/>`_ datasets\nto be easily coupled with other datasets or models that expose a `Basic Model Interface <https://bmi.readthedocs.io/en/latest/>`_.\n\nThe current implementation supports 2D, 3D and 4D ROMS output datasets defined with geospatial and/or time dimensions (e.g.,\ndataset defined with dimensions as [time, s_rho, eta_rho, xi_rho])\n\n========= ===================================\nComponent PyMT\n========= ===================================\nRoms `from pymt.models import Roms`\n========= ===================================\n\n---------------\nInstalling pymt\n---------------\n\nInstalling `pymt` from the `conda-forge` channel can be achieved by adding\n`conda-forge` to your channels with:\n\n.. code::\n\n conda config --add channels conda-forge\n\n*Note*: Before installing `pymt`, you may want to create a separate environment\ninto which to install it. This can be done with,\n\n.. code::\n\n conda create -n pymt python=3\n conda activate pymt\n\n.. Once the `conda-forge` channel has been enabled, `pymt` can be installed with:\n\nOnce the environment is activated, `pymt` can be installed with the following command.\nPlease note that the `pymt_roms` requires the development version of `pymt` (e.g., v1.3.2dev0).\n\n.. code::\n\n pip install git+https://github.com/csdms/pymt.git\n\n.. conda install pymt\n\n.. It is possible to list all of the versions of `pymt` available on your platform with:\n\n.. .. code::\n\n.. conda search pymt --channel conda-forge\n\n--------------------\nInstalling pymt_roms\n--------------------\n\nTo install `pymt_roms`, use pip\n\n.. code::\n\n pip install pymt_roms\n\nor conda\n\n.. code::\n\n conda install -c conda-forge pymt_roms\n\n--------------------\nCoding Example\n--------------------\n\nYou can learn more details about the coding example from the\n`tutorial notebook <https://github.com/gantian127/pymt_roms/blob/master/notebooks/pymt_roms.ipynb>`_.\n\n\nCredits\n=======\n\n* Tian Gan <gantian127@gmail.com>\n\n\nChangelog for pymt_roms\n=======================\n\n0.2.0 (unreleased)\n-------------------\n\n\n0.1.0 (2023-04-04)\n------------------\n\n- Initial release\n\n",
"bugtrack_url": null,
"license": "",
"summary": "PyMT plugin for pymt_roms",
"version": "0.1",
"split_keywords": [
"bmi",
"pymt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "535b199607d37fd8d767e651b94044bda0c55af5db1449007ef277f00e8e1001",
"md5": "434399491d01dae031d103d25b23ea88",
"sha256": "268cc72fb0f3d2238594531d882f2342013ed2cee5ad7c9210af5bdef8506c29"
},
"downloads": -1,
"filename": "pymt_roms-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "434399491d01dae031d103d25b23ea88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5781,
"upload_time": "2023-04-20T22:20:19",
"upload_time_iso_8601": "2023-04-20T22:20:19.986782Z",
"url": "https://files.pythonhosted.org/packages/53/5b/199607d37fd8d767e651b94044bda0c55af5db1449007ef277f00e8e1001/pymt_roms-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-20 22:20:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "gantian127",
"github_project": "pymt_roms",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pymt-roms"
}
JSON
