standard-names


Namestandard-names JSON
Version 0.2.9 PyPI version JSON
download
home_page
SummaryPython utilities for working with CSDMS Standard Names
upload_time2024-03-04 03:14:53
maintainerEric Hutton, Mark Piper, The CSDMS team
docs_urlNone
authorEric Hutton
requires_python>=3.10
licenseMIT
keywords csdms python standard names utilities
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![[Python][pypi-link]][python-badge]
![[Build Status][build-link]][build-badge]
![[PyPI][pypi-link]][pypi-badge]
![[Build Status][anaconda-link]][anaconda-badge]


[anaconda-badge]: https://anaconda.org/conda-forge/standard_names/badges/version.svg
[anaconda-link]: https://anaconda.org/conda-forge/standard_names
[build-badge]: https://github.com/csdms/standard_names/actions/workflows/test.yml/badge.svg
[build-link]: https://github.com/csdms/standard_names/actions/workflows/test.yml
[csdms-workbench]: https://csdms.colorado.edu/wiki/Workbench
[pypi-badge]: https://badge.fury.io/py/standard_names.svg
[pypi-link]: https://pypi.org/project/standard_names/
[python-badge]: https://img.shields.io/pypi/pyversions/standard_names.svg

# standard_names

Python utilities for working with CSDMS Standard Names.

CSDMS Standard Names is an element of the [CSDMS Workbench][csdms-workbench],
an integrated system of software tools, technologies, and standards
for building and coupling models.

## As Regular Expression

```
^                           # Start of the object name
[a-z]+                      # Starts with one or more lowercase letters
(?:                         # Start of a non-capturing group for subsequent parts
    [-~_]?                  # Optional separator: hyphen, tilde, or underscore
    [a-zA-Z0-9]+            # One or more alphanumeric characters
)*                          # Zero or more repetitions of the group
__                          # Double underscore separator
[a-z]+                      # Start of the quantity
(?:                         # Start of a non-capturing group for subsequent parts
    [-~_]?                  # Optional separator: hyphen, tilde, or underscore
    [a-zA-Z0-9]+            # One or more alphanumeric characters
)*                          # Zero or more repetitions of the group
$                           # End of the name
```

## As Parsing Expression Grammar

```peg
Start
    = LowercaseWord UnderscoreSeparator LowercaseWord

LowercaseWord
    = [a-z] AdditionalCharacters*

AdditionalCharacters
    = Separator? Alphanumeric+

Separator
    = "-" / "~" / "_"

Alphanumeric
    = [a-zA-Z0-9]

UnderscoreSeparator
    = "__"
```

# Links

*  [Source code](http://github.com/csdms/standard_names): The
   *standard_names* source code repository.
*  [Documentation](http://standard-names.readthedocs.io/): User documentation
   for *standard_names*
*  [Get](http://standard-names.readthedocs.io/en/latest/getting.html):
   Installation instructions
*  [Registry](http://github.com/csdms/standard_names_registry): The
   official registry of CSDMS Standard Names.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "standard-names",
    "maintainer": "Eric Hutton, Mark Piper, The CSDMS team",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "eric.hutton@colorado.edu, mark.piper@colorado.edu, csdms@colorado.edu",
    "keywords": "csdms,python,standard names,utilities",
    "author": "Eric Hutton",
    "author_email": "eric.hutton@colorado.edu",
    "download_url": "https://files.pythonhosted.org/packages/44/9b/143bddb1961301c9c38aa29923b68ecb0c44b79d919556c3a28561ae530c/standard_names-0.2.9.tar.gz",
    "platform": null,
    "description": "![[Python][pypi-link]][python-badge]\n![[Build Status][build-link]][build-badge]\n![[PyPI][pypi-link]][pypi-badge]\n![[Build Status][anaconda-link]][anaconda-badge]\n\n\n[anaconda-badge]: https://anaconda.org/conda-forge/standard_names/badges/version.svg\n[anaconda-link]: https://anaconda.org/conda-forge/standard_names\n[build-badge]: https://github.com/csdms/standard_names/actions/workflows/test.yml/badge.svg\n[build-link]: https://github.com/csdms/standard_names/actions/workflows/test.yml\n[csdms-workbench]: https://csdms.colorado.edu/wiki/Workbench\n[pypi-badge]: https://badge.fury.io/py/standard_names.svg\n[pypi-link]: https://pypi.org/project/standard_names/\n[python-badge]: https://img.shields.io/pypi/pyversions/standard_names.svg\n\n# standard_names\n\nPython utilities for working with CSDMS Standard Names.\n\nCSDMS Standard Names is an element of the [CSDMS Workbench][csdms-workbench],\nan integrated system of software tools, technologies, and standards\nfor building and coupling models.\n\n## As Regular Expression\n\n```\n^                           # Start of the object name\n[a-z]+                      # Starts with one or more lowercase letters\n(?:                         # Start of a non-capturing group for subsequent parts\n    [-~_]?                  # Optional separator: hyphen, tilde, or underscore\n    [a-zA-Z0-9]+            # One or more alphanumeric characters\n)*                          # Zero or more repetitions of the group\n__                          # Double underscore separator\n[a-z]+                      # Start of the quantity\n(?:                         # Start of a non-capturing group for subsequent parts\n    [-~_]?                  # Optional separator: hyphen, tilde, or underscore\n    [a-zA-Z0-9]+            # One or more alphanumeric characters\n)*                          # Zero or more repetitions of the group\n$                           # End of the name\n```\n\n## As Parsing Expression Grammar\n\n```peg\nStart\n    = LowercaseWord UnderscoreSeparator LowercaseWord\n\nLowercaseWord\n    = [a-z] AdditionalCharacters*\n\nAdditionalCharacters\n    = Separator? Alphanumeric+\n\nSeparator\n    = \"-\" / \"~\" / \"_\"\n\nAlphanumeric\n    = [a-zA-Z0-9]\n\nUnderscoreSeparator\n    = \"__\"\n```\n\n# Links\n\n*  [Source code](http://github.com/csdms/standard_names): The\n   *standard_names* source code repository.\n*  [Documentation](http://standard-names.readthedocs.io/): User documentation\n   for *standard_names*\n*  [Get](http://standard-names.readthedocs.io/en/latest/getting.html):\n   Installation instructions\n*  [Registry](http://github.com/csdms/standard_names_registry): The\n   official registry of CSDMS Standard Names.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python utilities for working with CSDMS Standard Names",
    "version": "0.2.9",
    "project_urls": {
        "Documentation": "https://standard-names.readthedocs.io/",
        "Homepage": "https://csdms.colorado.edu",
        "Issues": "https://github.com/csdms/standard_names/issues",
        "Repository": "https://github.com/csdms/standard_names"
    },
    "split_keywords": [
        "csdms",
        "python",
        "standard names",
        "utilities"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "449b143bddb1961301c9c38aa29923b68ecb0c44b79d919556c3a28561ae530c",
                "md5": "3947ed248d60d3fa144321887f358ee3",
                "sha256": "e224d1ceae89fb7ebb4439eb9d7e25da190d6a2d289b38e1e7404ecbd85439e3"
            },
            "downloads": -1,
            "filename": "standard_names-0.2.9.tar.gz",
            "has_sig": false,
            "md5_digest": "3947ed248d60d3fa144321887f358ee3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 93295,
            "upload_time": "2024-03-04T03:14:53",
            "upload_time_iso_8601": "2024-03-04T03:14:53.907485Z",
            "url": "https://files.pythonhosted.org/packages/44/9b/143bddb1961301c9c38aa29923b68ecb0c44b79d919556c3a28561ae530c/standard_names-0.2.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-04 03:14:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "csdms",
    "github_project": "standard_names",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "standard-names"
}
        
Elapsed time: 4.11698s