{
    "info": {
        "author": "pennythewho",
        "author_email": "who@pennythewho.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3.7"
        ],
        "description": "# SeaFreeze\n\nV0.9.1\n\nThe SeaFreeze package allows computation of the thermodynamic and elastic properties of water and ice polymorphs Ih, III, V and VI in the 0-2300 MPa and 220-500 K range. It is based on the evaluation of Local Basis Functions for each phase. The formalism is described in more details in Brown (2018), Journaux et al. (2019), and in the liquid water Gibbs parametrization by Bollengier, Brown, and Shaw (2019).\n\n\n## Installation\nThis package will install [uw-highP-geophysics-tools](https://pypi.org/project/uw-highP-geophysics-tools/) and its dependencies.\n\nRun the following command to install\n\n`pip3 install SeaFreeze`\n\n\n## `seafreeze.seafreeze`: calculating thermodynamic and elastic properties of a phase of water\n\n### Usage\nThe main function of SeaFreeze is `seafreeze.seafreeze`, which has the following parameters:\n- `PT`: the pressure (MPa) and temperature (K) conditions at which the thermodynamic quantities should be\n  calculated -- note that these are required units, as conversions are built into several calculations\n  This parameter can have one of the following formats:\n  - a 1-dimensional numpy array of tuples with one or more scattered (P,T) tuples \n  - a numpy array with 2 nested numpy arrays, the first with pressures and the second\n    with temperatures -- each inner array must be sorted from low to high values\n    a grid will be constructed from the P and T arrays such that each row of the output\n    will correspond to a pressure and each column to a temperature \n- `phase`: indicates the phase of H\u2082O.  Supported phases are\n  - 'Ih' - from  Feistel and Wagner, 2006\n  - 'III' - from Journaux et al, 2019\n  - 'V' - from Journaux et al, 2019\n  - 'VI' - from Journaux et al, 2019\n  - 'water1' -  extends to 500 K and 2300 MPa; from Bollengier et al 2019\n  - 'water2' -  extends to 100 GPa; from Brown 2018\n  - 'water_IAPWS95' - LBF representation of IAPWS 95; from Wagner and Pru\u00df, 2002\n\n\nThe output of the function is an object with properties corresponding to the following thermodynamic quantities\n(all but the last three are from [lbftd](https://github.com/jmichaelb/LocalBasisFunction/tree/master/Python/lbftd)):\n- _G_:  Gibbs energy in J kg<sup>-1</sup>\n- _rho_: density in kg m<sup>-3</sup>\n- _vel_: sound speed in m s<sup>-1</sup>\n- _Cp_: isobaric specific heat in J kg<sup>-1</sup> K<sup>-1</sup>\n- _Cv_: isochoric specific heat in J kg<sup>-1</sup> K<sup>-1</sup>\n- _alpha_: thermal expansivity in K<sup>-1</sup>\n- _U_: internal energy in J kg<sup>-1</sup>\n- _A_: Helmholtz energy in J kg<sup>-1</sup>\n- _H_: enthalpy in J kg<sup>-1</sup>\n- _S_: entropy in J kg<sup>-1</sup> K<sup>-1</sup>\n- _Kt_: isothermal bulk modulus in MPa\n- _Kp_: pressure derivatives of isothermal bulk modulus (dimensionless)\n- _Ks_: isotropic bulk modulus in MPa\n- _V_: unit volume in m<sup>3</sup> kg<sup>-1</sup>\n- _Vp_: compressional wave velocity in m s<sup>-1</sup>\n- _Vs_: shear wave velocity in m s<sup>-1</sup>\n- _shear_: shear modulus in MPa\n\n### Example\n\n```python\nimport numpy as np\nimport seafreeze as sf\n\n# list supported phases\nsf.phases.keys()\n\n# evaluate thermodynamics for ice VI at 900 MPa and 255 K\nPT = np.empty((1,), np.object)\nPT[0] = (900, 255)\nout = sf.seafreeze(PT, 'VI')\n# view a couple of the calculated thermodynamic quantities at this P and T\nout.rho     # density\nout.Vp      # compressional wave velocity\n\n# evaluate thermodynamics for water at three separate PT conditions\nPT = np.empty((3,), np.object)\nPT[0] = (441.0858, 313.95)\nPT[1] = (478.7415, 313.96)\nPT[2] = (444.8285, 313.78)\nout = sf.seafreeze(PT, 'water1')\n# values for output fields correspond positionally to (P,T) tuples \nout.H       # enthalpy\n\n# evaluate ice V thermodynamics at pressures 400-500 MPa and temperatures 240-250 K\nP = np.arange(400, 501, 2)\nT = np.arange(240, 250.1, 0.5)\nPT = np.array([P, T])\nout = sf.seafreeze(PT, 'V')\n# rows in output correspond to pressures; columns to temperatures\nout.A       # Helmholtz energy\nout.shear   # shear modulus\n```\n\n\n## `seafreeze.whichphase`: determining the stable phase of water\n\n### Usage\nSeafreeze also includes a function to determine which of the *supported* phases is stable\nunder the given pressure and temperature conditions. \nThe function `seafreeze.whichphase` has a single parameter, `PT`, \nwhich requires the same format as in the `seafreeze.seafreeze` function.\n\nThe output of the function is a [Numpy array](https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html)\nwith an integer indicating the phase number corresponding to the `PT` input.  The phase number 0 means \nliquid water, phase number 1 means ice Ih, phase number 3 means ice III, etc.\n- for a list of scattered (P,T) conditions, each value corresponds to the same index in the input\n- for a grid of PT conditions, each row corresponds to a pressure and each column to a temperature from the input.\n\n`seafreeze.phasenum2phase` can be used to map output phase numbers to a phase.  \nEach item in this dictionary has the phase number as its key and the phase as the value. \n\n### Example\n\n```python\nimport numpy as np\nimport seafreeze as sf\n\n# determine the phase of water at 900 MPa and 255 K\nPT = np.empty((1,), np.object)\nPT[0] = (900, 255)\nout = sf.whichphase(PT)\n# map to a phase using phasenum2phase\nsf.phasenum2phase[out[0]]\n\n\n# determine phase for three separate (P,T) conditions\nPT = np.empty((3,), np.object)\nPT[0] = (100, 200)\nPT[1] = (400, 250)\nPT[2] = (1000, 300)\nout = sf.whichphase(PT)\n# show phase for each (P,T)\n[(PT, sf.phasenum2phase[pn]) for (PT, pn) in zip(PT, out)]\n\n# find the likely phases at pressures 0-5 MPa and temperatures 240-300 K\nP = np.arange(0, 5, 0.1)\nT = np.arange(240, 300)\nPT = np.array([P, T])\nout = sf.whichphase(PT)\n```\n\n## Change log\n\n### Changes since 0.9.0\n- `0.9.1`: add `whichphase` function\n\n### Changes from 0.8\n- rename function get_phase_thermodynamics to seafreeze\n- reverse order of PT and phase in function signature\n- remove a layer of nesting (`seafreeze.seafreeze` rather than `seafreeze.seafreeze.seafreeze`)\n\n\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/Bjournaux/SeaFreeze",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "SeaFreeze",
        "package_url": "https://pypi.org/project/SeaFreeze/",
        "platform": "",
        "project_url": "https://pypi.org/project/SeaFreeze/",
        "project_urls": {
            "Homepage": "https://github.com/Bjournaux/SeaFreeze"
        },
        "release_url": "https://pypi.org/project/SeaFreeze/0.9.1.post2/",
        "requires_dist": [
            "uw-highP-geophysics-tools (>=0.8)"
        ],
        "requires_python": "",
        "summary": "thermodynamic properties of the phases of H\u2082O",
        "version": "0.9.1.post2"
    },
    "last_serial": 5652086,
    "releases": {
        "0.8.1a0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "198265ea5bde69ab10c542d9dacdd2f5",
                    "sha256": "bc1b6e441de41ffd9d790ce45f5877cb3c229a42023221452fa52966696d91b2"
                },
                "downloads": -1,
                "filename": "SeaFreeze-0.8.1a0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "198265ea5bde69ab10c542d9dacdd2f5",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 1352680,
                "upload_time": "2019-07-30T22:41:58",
                "url": "https://files.pythonhosted.org/packages/55/cc/17e0ca8d792243556dfe90a5bee60c2cbb6c8bce23df7f62696c7ae63a92/SeaFreeze-0.8.1a0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "cbd007c7081063983d0f891783c8c416",
                    "sha256": "2eb96d115644f90c2e6254754ad27d651519be916ede24d4bb4fe66ccc4cb6a2"
                },
                "downloads": -1,
                "filename": "SeaFreeze-0.8.1a0.tar.gz",
                "has_sig": false,
                "md5_digest": "cbd007c7081063983d0f891783c8c416",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5169,
                "upload_time": "2019-07-30T22:41:59",
                "url": "https://files.pythonhosted.org/packages/5d/94/6be43ca8fb42454177e54866462d036b04d0ae6a27c6ee11eca5f2ae123c/SeaFreeze-0.8.1a0.tar.gz"
            }
        ],
        "0.9.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e49a161fa4b3d73534d269d34d6433b5",
                    "sha256": "b0b059b8c088b5e96e2f30c41338830979adee39987eb408321c4410ac20110e"
                },
                "downloads": -1,
                "filename": "SeaFreeze-0.9.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e49a161fa4b3d73534d269d34d6433b5",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 1355583,
                "upload_time": "2019-08-07T01:18:20",
                "url": "https://files.pythonhosted.org/packages/e1/9d/48f2972eed31b6d7eec3314dbcec4d4d28b0dd66eb389b461d258595b909/SeaFreeze-0.9.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "2feb89d04e5dbc525e9f15c588e73382",
                    "sha256": "82bafbd210628a3aaba7faea114817e787174f84b3b6756867fd2796e5eadf14"
                },
                "downloads": -1,
                "filename": "SeaFreeze-0.9.0.tar.gz",
                "has_sig": false,
                "md5_digest": "2feb89d04e5dbc525e9f15c588e73382",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5290,
                "upload_time": "2019-08-07T01:18:22",
                "url": "https://files.pythonhosted.org/packages/83/95/4f2479cde99fcfd8b30cf8fe59a99682eaf445409b208aefa240f97b27dd/SeaFreeze-0.9.0.tar.gz"
            }
        ],
        "0.9.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1a0cb204b7a5a7f6251f01ffe1179ddb",
                    "sha256": "d72772ecbc587bdff90254ce49b9437b4952ea71823b018d0e66db6fcac29c28"
                },
                "downloads": -1,
                "filename": "SeaFreeze-0.9.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "1a0cb204b7a5a7f6251f01ffe1179ddb",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 1357026,
                "upload_time": "2019-08-08T19:40:15",
                "url": "https://files.pythonhosted.org/packages/dc/c4/b4a5982eda813aa355f74554fa2bbe4a9de345f2fe77fb30ca6e645d8ec4/SeaFreeze-0.9.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "ab99129647b1a746c2758c1ecd3edb9e",
                    "sha256": "b5804508e375deae547d62b0cec63a8050a520695fde0136fe0129be8ba28b09"
                },
                "downloads": -1,
                "filename": "SeaFreeze-0.9.1.tar.gz",
                "has_sig": false,
                "md5_digest": "ab99129647b1a746c2758c1ecd3edb9e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6417,
                "upload_time": "2019-08-08T19:40:17",
                "url": "https://files.pythonhosted.org/packages/36/da/ce9c8edae7ba72f128bce890c1df4fabd3708fcfd44107f43831c971b0ac/SeaFreeze-0.9.1.tar.gz"
            }
        ],
        "0.9.1.post1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "072212d4ddb22528a01319dee2c9dc2c",
                    "sha256": "b2304ff1b53ac3cb123c25e2d86e01bdfdce4ca2af7f3f2de8608e29fce06a44"
                },
                "downloads": -1,
                "filename": "SeaFreeze-0.9.1.post1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "072212d4ddb22528a01319dee2c9dc2c",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 1357219,
                "upload_time": "2019-08-08T19:50:17",
                "url": "https://files.pythonhosted.org/packages/b3/d3/797b899984587cbb338b7aaf197cb31b0d91c90d969687c12cb1dbd365ed/SeaFreeze-0.9.1.post1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "afecb4ac593859d2a8daec2e429bfd39",
                    "sha256": "8ad176925912deb770e7e294db593aa6e2c10ab4d29338e7b076bc71e341c1e7"
                },
                "downloads": -1,
                "filename": "SeaFreeze-0.9.1.post1.tar.gz",
                "has_sig": false,
                "md5_digest": "afecb4ac593859d2a8daec2e429bfd39",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6502,
                "upload_time": "2019-08-08T19:50:20",
                "url": "https://files.pythonhosted.org/packages/f2/3a/1161fbacd48abfb51ec3db90d84a06a72138b95c234dc4c554947b3fbf61/SeaFreeze-0.9.1.post1.tar.gz"
            }
        ],
        "0.9.1.post2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fc0dac1d168fa36172c693e206105b83",
                    "sha256": "578eea16e603ee33cf7b2f00c5edb9d20123a0ba564d9dff506fe8d1efcb6fc1"
                },
                "downloads": -1,
                "filename": "SeaFreeze-0.9.1.post2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "fc0dac1d168fa36172c693e206105b83",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 1357602,
                "upload_time": "2019-08-08T20:29:38",
                "url": "https://files.pythonhosted.org/packages/01/cc/a3fe326c3655f5f9bf27c0346f516313e331094b066d2f514be4b9b3c963/SeaFreeze-0.9.1.post2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "e11c8283e5101b825b2a54f9672330cd",
                    "sha256": "547af72619cf06eada04726fb94e65e5fdee4eb350deabab3a7d8e8eba5e4740"
                },
                "downloads": -1,
                "filename": "SeaFreeze-0.9.1.post2.tar.gz",
                "has_sig": false,
                "md5_digest": "e11c8283e5101b825b2a54f9672330cd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6744,
                "upload_time": "2019-08-08T20:29:41",
                "url": "https://files.pythonhosted.org/packages/cb/14/cda57bfdbe02e147db90b6da1cdf3f6b5fa1b96ff9313451aae680a72c26/SeaFreeze-0.9.1.post2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "fc0dac1d168fa36172c693e206105b83",
                "sha256": "578eea16e603ee33cf7b2f00c5edb9d20123a0ba564d9dff506fe8d1efcb6fc1"
            },
            "downloads": -1,
            "filename": "SeaFreeze-0.9.1.post2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fc0dac1d168fa36172c693e206105b83",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 1357602,
            "upload_time": "2019-08-08T20:29:38",
            "url": "https://files.pythonhosted.org/packages/01/cc/a3fe326c3655f5f9bf27c0346f516313e331094b066d2f514be4b9b3c963/SeaFreeze-0.9.1.post2-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "e11c8283e5101b825b2a54f9672330cd",
                "sha256": "547af72619cf06eada04726fb94e65e5fdee4eb350deabab3a7d8e8eba5e4740"
            },
            "downloads": -1,
            "filename": "SeaFreeze-0.9.1.post2.tar.gz",
            "has_sig": false,
            "md5_digest": "e11c8283e5101b825b2a54f9672330cd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6744,
            "upload_time": "2019-08-08T20:29:41",
            "url": "https://files.pythonhosted.org/packages/cb/14/cda57bfdbe02e147db90b6da1cdf3f6b5fa1b96ff9313451aae680a72c26/SeaFreeze-0.9.1.post2.tar.gz"
        }
    ]
}