jaxmod


Namejaxmod JSON
Version 0.2.3 PyPI version JSON
download
home_pageNone
SummaryLightweight utility functions for JAX arrays, batching, and pytrees
upload_time2025-10-25 09:38:31
maintainerNone
docs_urlNone
authorNone
requires_python<=4.0,>=3.11
licenseNone
keywords equinox jax
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # Jaxmod

[![Release 0.2.3](https://img.shields.io/badge/Release-0.2.3-blue.svg)](https://github.com/ExPlanetology/jaxmod/releases/tag/v0.9.3)
[![Python 3.11+](https://img.shields.io/badge/Python-3.11+-blue.svg)](https://www.python.org/downloads/release/python-3110/)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![CI](https://github.com/ExPlanetology/jaxmod/actions/workflows/ci.yml/badge.svg)](https://github.com/ExPlanetology/jaxmod/actions/workflows/ci.yml)
[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
[![bear-ified](https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg)](https://beartype.readthedocs.io)
[![Test coverage](https://img.shields.io/badge/Coverage-87%25-brightgreen)](https://github.com/ExPlanetology/jaxmod)

## About
Jaxmod is a Python package that provides lightweight utility functions for JAX arrays, batching, and pytrees. It mostly builds on top of the amazing [Equinox](https://docs.kidger.site/equinox/) package, whilst notably incorporating structural conventions and helper functions that make JAX-based scientific programming more convenient and consistent.

Although generally useful for numerical and scientific computing, *Jaxmod* is somewhat biased toward applications in chemistry, geochemistry, and planetary science, where tasks like handling stoichiometric matrices, managing physical constants, and ensuring numerical stability are common.

## Documentation

The documentation is available online, with options to download it in EPUB or PDF format:

[https://jaxmod.readthedocs.io/en/latest/](https://jaxmod.readthedocs.io/en/latest/)

## Quick install

Jaxmod is a Python package that can be installed on a variety of platforms (e.g. Mac, Windows, Linux). It is recommended to install Jaxmod in a dedicated Python environment. Before installation, create and activate the environment, then run:

```pip install jaxmod```
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "jaxmod",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<=4.0,>=3.11",
    "maintainer_email": null,
    "keywords": "equinox, jax",
    "author": null,
    "author_email": "Dan J Bower <dbower@eaps.ethz.ch>",
    "download_url": "https://files.pythonhosted.org/packages/2b/10/e0a602847c07a6eaad2ca0f2da6a6d0bbd0cfae0bf35abf6fce280831fe9/jaxmod-0.2.3.tar.gz",
    "platform": null,
    "description": "# Jaxmod\n\n[![Release 0.2.3](https://img.shields.io/badge/Release-0.2.3-blue.svg)](https://github.com/ExPlanetology/jaxmod/releases/tag/v0.9.3)\n[![Python 3.11+](https://img.shields.io/badge/Python-3.11+-blue.svg)](https://www.python.org/downloads/release/python-3110/)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![CI](https://github.com/ExPlanetology/jaxmod/actions/workflows/ci.yml/badge.svg)](https://github.com/ExPlanetology/jaxmod/actions/workflows/ci.yml)\n[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)\n[![bear-ified](https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg)](https://beartype.readthedocs.io)\n[![Test coverage](https://img.shields.io/badge/Coverage-87%25-brightgreen)](https://github.com/ExPlanetology/jaxmod)\n\n## About\nJaxmod is a Python package that provides lightweight utility functions for JAX arrays, batching, and pytrees. It mostly builds on top of the amazing [Equinox](https://docs.kidger.site/equinox/) package, whilst notably incorporating structural conventions and helper functions that make JAX-based scientific programming more convenient and consistent.\n\nAlthough generally useful for numerical and scientific computing, *Jaxmod* is somewhat biased toward applications in chemistry, geochemistry, and planetary science, where tasks like handling stoichiometric matrices, managing physical constants, and ensuring numerical stability are common.\n\n## Documentation\n\nThe documentation is available online, with options to download it in EPUB or PDF format:\n\n[https://jaxmod.readthedocs.io/en/latest/](https://jaxmod.readthedocs.io/en/latest/)\n\n## Quick install\n\nJaxmod is a Python package that can be installed on a variety of platforms (e.g. Mac, Windows, Linux). It is recommended to install Jaxmod in a dedicated Python environment. Before installation, create and activate the environment, then run:\n\n```pip install jaxmod```",
    "bugtrack_url": null,
    "license": null,
    "summary": "Lightweight utility functions for JAX arrays, batching, and pytrees",
    "version": "0.2.3",
    "project_urls": {
        "documentation": "https://jaxmod.readthedocs.io/en/latest",
        "homepage": "https://planetology.ethz.ch",
        "issues": "https://github.com/ExPlanetology/jaxmod/issues",
        "repository": "https://github.com/ExPlanetology/jaxmod"
    },
    "split_keywords": [
        "equinox",
        " jax"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6ad154170093b92575afa9a5238260b6d0561528a838429c30f394cbf7704992",
                "md5": "f0b5609e59f2fb171429ae8e56dc4c1e",
                "sha256": "d934ca422ee57327db0ccfef2d2c820d17a8367f29c673726faa7a50e6e1b1eb"
            },
            "downloads": -1,
            "filename": "jaxmod-0.2.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f0b5609e59f2fb171429ae8e56dc4c1e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<=4.0,>=3.11",
            "size": 22515,
            "upload_time": "2025-10-25T09:38:29",
            "upload_time_iso_8601": "2025-10-25T09:38:29.875265Z",
            "url": "https://files.pythonhosted.org/packages/6a/d1/54170093b92575afa9a5238260b6d0561528a838429c30f394cbf7704992/jaxmod-0.2.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2b10e0a602847c07a6eaad2ca0f2da6a6d0bbd0cfae0bf35abf6fce280831fe9",
                "md5": "59dd1d71b99d6b4c032ccdf1f6e84ae1",
                "sha256": "1a3a29408c3bad062bf080ebfc89231369d64622c987bc8df4e172e154029a33"
            },
            "downloads": -1,
            "filename": "jaxmod-0.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "59dd1d71b99d6b4c032ccdf1f6e84ae1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<=4.0,>=3.11",
            "size": 28952,
            "upload_time": "2025-10-25T09:38:31",
            "upload_time_iso_8601": "2025-10-25T09:38:31.057345Z",
            "url": "https://files.pythonhosted.org/packages/2b/10/e0a602847c07a6eaad2ca0f2da6a6d0bbd0cfae0bf35abf6fce280831fe9/jaxmod-0.2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-25 09:38:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ExPlanetology",
    "github_project": "jaxmod",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "jaxmod"
}
        
Elapsed time: 0.53777s