{
    "info": {
        "author": "Ofer Shamir",
        "author_email": "ofer.shamir@mail.huji.ac.il",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "## pymaws: Matsuno Analytical Wave Solution implemented in Python \nA python module for evaluating the initial conditions used in: [The Matsuno baroclinic wave test case](https://www.geosci-model-dev-discuss.net/gmd-2018-260/) (under review for GEOSCI. MODEL DEV.).\n\n### Installation\n\npymaws has minimal requirements of:\n\n- Python 3.4 to 3.7\n- numpy  1.16\n\nThe package can be installed using ``pip``:\n\n  \t$ pip install pymaws\n\n### Testing\nThe testing procedure tests all the parts of pymaws and should take anywhere from a few seconds upto 20 seconds due to random elements in the tests.\nTo run the tests, use python3 in the command line:\n\n\t$ python test_pymaws.py\n  You should get ``OK`` in the last line.\n\n### Getting Started\nIn the python environmnet, start by importing pymaws with the command:\n\n\t$ from pymaws import *\nThe main function ``eval_field`` was loaded to your environment and a dictionary named ``Earth`` that stores the planetary parameters used in this package. (if you want to run ``eval_field`` with different parameters , see below)\n\n\n### Example\nLet's begin with a regular grid of lat/lon on a 20 second time interval:\n\n\t$ import numpy as np\n\t$ nlats = 100\n\t$ nlons = 200\n\t$ ntime = 50\n\t$ lats = np.deg2rad(np.linspace(-80, 80, nlats))\n\t$ lons = np.deg2rad(np.linspace(-180, 180, nlons))\n\t$ time = np.linspace(0.0, 20, ntime)\nNow, let's evaluate the meridional velocity field of an Eastward propagating Inertia-Gravity (EIG) wave:\n\n    $ v = np.zeros((ntime, nlats, nlons))\n    $ for t in range(ntime):\n    $     for j in range(nlats):\n    $         for i in range(nlons):\n    $             v[t, j, i] = eval_field(lats[j], lons[i], time[t], \n    $                                           field='v', wave_type='EIG')\n\n\t$ v.shape\n\t$ (50, 200, 100)\nNote that the default arguments of ``eval_field`` are ``n=1, k=5, amp=1e-5, wave_type='Rossby'`` and ``parameters=Earth``. \nThis package does not include visualizations of any kind, but you can use ``matplotlib``, e.g.\n\n    $ from matplotlib import pyplot as plt\n    $ plt.contourf(np.rad2deg(lons), np.rad2deg(lats), v[0, :, :])\n    $ plt.xlim(-36,36)\n    $ plt.ylim(-30,30)\n\n![Meridional velocity at t=0](https://github.com/ofershamir/matsuno/raw/master/example_v.png) \n*Meridional velocity at t=0*\n\n\n\n### Caveats\n\nThis version of pymaws does not solve Matsuno equations for n, k < 1, \n\n### Planetary Parameters:\nThe default parameters in ``pymaws`` are stored in a dictionary named ``Earth``:\n\n\t$  {'angular_frequency': 7.29212e-05,\n\t      'gravitational_acceleration': 9.80616,\n\t      'mean_radius': 6371220.0,\n\t      'layer_mean_depth': 30.0}\nIf you want to use different planetary parameters,  just copy the dictionary ``Earth`` and replace the appropriate values. For example lets change the ``layer_mean_depth`` parameter to 10 meters: \n\n\t$   Earth_1 = Earth.copy()\n\t$   Earth_1['layer_mean_depth'] = 10.0\nWhen you run ``eval_field``, remember to use the argument ``parameters=Earth_1``.\n### How to cite pymaws\n\nIf you use pymaws in your academic work and publish a paper, we kindly ask that you cite pymaws using the following DOI:\n\n### License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n### Authors\n\n* **Ofer Shamir** - *ofer.shamir@mail.huji.ac.il*\n* **Shlomi Ziskin Ziv** - *shlomiziskin@gmail.com*\n\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/ofershamir/matsuno",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "pymaws",
        "package_url": "https://pypi.org/project/pymaws/",
        "platform": "",
        "project_url": "https://pypi.org/project/pymaws/",
        "project_urls": {
            "Homepage": "https://github.com/ofershamir/matsuno"
        },
        "release_url": "https://pypi.org/project/pymaws/0.1.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Matsuno Analytical Wave Solution implemented in Python",
        "version": "0.1.0"
    },
    "last_serial": 4979871,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "bd1c59fc06fcdef442a824304887b293",
                    "sha256": "95f0511edc9a1f70b7118481325a4ca71a1d3ddafff7358b85b7804cdfbf9e72"
                },
                "downloads": -1,
                "filename": "pymaws-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "bd1c59fc06fcdef442a824304887b293",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 10379,
                "upload_time": "2019-03-24T21:02:55",
                "url": "https://files.pythonhosted.org/packages/8e/91/94e19d95ef13382fa1476239c8ee2e844e41980e4033f8a928431ade1d24/pymaws-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "73dffc85d4f1d861e550b40e5ee57993",
                    "sha256": "cdfd371c89ec288b04233b4b2a857899da896f904af60197cc91d96233c7d0dd"
                },
                "downloads": -1,
                "filename": "pymaws-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "73dffc85d4f1d861e550b40e5ee57993",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9873,
                "upload_time": "2019-03-24T21:02:57",
                "url": "https://files.pythonhosted.org/packages/b1/d0/6f089e33ed1babcbb810d51806a134c8f0e92fd6622072bd25d103eff27c/pymaws-0.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "bd1c59fc06fcdef442a824304887b293",
                "sha256": "95f0511edc9a1f70b7118481325a4ca71a1d3ddafff7358b85b7804cdfbf9e72"
            },
            "downloads": -1,
            "filename": "pymaws-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bd1c59fc06fcdef442a824304887b293",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 10379,
            "upload_time": "2019-03-24T21:02:55",
            "url": "https://files.pythonhosted.org/packages/8e/91/94e19d95ef13382fa1476239c8ee2e844e41980e4033f8a928431ade1d24/pymaws-0.1.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "73dffc85d4f1d861e550b40e5ee57993",
                "sha256": "cdfd371c89ec288b04233b4b2a857899da896f904af60197cc91d96233c7d0dd"
            },
            "downloads": -1,
            "filename": "pymaws-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "73dffc85d4f1d861e550b40e5ee57993",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9873,
            "upload_time": "2019-03-24T21:02:57",
            "url": "https://files.pythonhosted.org/packages/b1/d0/6f089e33ed1babcbb810d51806a134c8f0e92fd6622072bd25d103eff27c/pymaws-0.1.0.tar.gz"
        }
    ]
}