bw-temporalis


Namebw-temporalis JSON
Version 1.1.1 PyPI version JSON
download
home_pagehttps://github.com/brightway-lca/bw_temporalis
SummaryRevision of bw2temporalis for modern Brightway
upload_time2024-06-20 10:20:14
maintainerChris Mutel
docs_urlNone
authorChris Mutel
requires_python>=3.8
licenseBSD-3-Clause
keywords "brightway" "development"
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # bw_temporalis

[![PyPI](https://img.shields.io/pypi/v/bw_temporalis.svg)][pypi status]
[![Status](https://img.shields.io/pypi/status/bw_temporalis.svg)][pypi status]
[![Python Version](https://img.shields.io/pypi/pyversions/bw_temporalis)][pypi status]
[![License](https://img.shields.io/pypi/l/bw_temporalis)][license]

[![Read the documentation at https://bw_temporalis.readthedocs.io/](https://img.shields.io/readthedocs/bw_temporalis/latest.svg?label=Read%20the%20Docs)][read the docs]
[![Tests](https://github.com/brightway-lca/bw_temporalis/actions/workflows/python-test.yml/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/brightway-lca/bw_temporalis/branch/main/graph/badge.svg)][codecov]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[pypi status]: https://pypi.org/project/bw_temporalis/
[read the docs]: https://bw_temporalis.readthedocs.io/
[tests]: https://github.com/brightway-lca/bw_temporalis/actions/workflows/python-test.yml
[codecov]: https://app.codecov.io/gh/brightway-lca/bw_temporalis
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black

## Installation

You can install _bw_temporalis_ via [pip] from [PyPI]:

```console
$ pip install bw_temporalis
```

Currently Python 3.11 installations are broken as [scikit-network](https://scikit-network.readthedocs.io/en/latest/?badge=latest) only has pre-built wheels for version 0.31 - but this changed the [API for shortest path](https://github.com/sknetwork-team/scikit-network/blob/master/HISTORY.rst#0310-2023-05-22), and `bw_graph_tools` has not yet been adapted](https://github.com/brightway-lca/bw_graph_tools/issues/13).

You can also install using conda in the [cmutel channel](https://anaconda.org/cmutel/bw_temporalis).

## Usage notes

See [the teaching repo `from-the-ground-up`](https://github.com/brightway-lca/from-the-ground-up/tree/main/temporal) for examples on how to use this library.

This library uses the *net amount* in the technosphere and biosphere matrix, so caution should be taken in cases where multiple edges with temporal dynamics, especially with different numerical signs, link the same nodes. In general, these edges should be split across multiple processes.

The temporal resolution should not be less than seconds, it will be rounded up to seconds in the `TemporalDistribution`.

## Contributing

Contributions are very welcome.
To learn more, see the [Contributor Guide].

## License

Distributed under the terms of the [BSD 3 Clause license][license],
_bw_temporalis_ is free and open source software.

## Issues

If you encounter any problems,
please [file an issue] along with a detailed description.


<!-- github-only -->

[command-line reference]: https://bw_temporalis.readthedocs.io/en/latest/usage.html
[license]: https://github.com/brightway-lca/bw_temporalis/blob/main/LICENSE
[contributor guide]: https://github.com/brightway-lca/bw_temporalis/blob/main/CONTRIBUTING.md

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/brightway-lca/bw_temporalis",
    "name": "bw-temporalis",
    "maintainer": "Chris Mutel",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "<cmutel@gmail.com>",
    "keywords": "\"brightway\", \"development\"",
    "author": "Chris Mutel",
    "author_email": "<cmutel@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/0e/7c/44d842f267a5b97c14b91e491279a88800906f25889e74e37c20064a249a/bw_temporalis-1.1.1.tar.gz",
    "platform": "any",
    "description": "# bw_temporalis\n\n[![PyPI](https://img.shields.io/pypi/v/bw_temporalis.svg)][pypi status]\n[![Status](https://img.shields.io/pypi/status/bw_temporalis.svg)][pypi status]\n[![Python Version](https://img.shields.io/pypi/pyversions/bw_temporalis)][pypi status]\n[![License](https://img.shields.io/pypi/l/bw_temporalis)][license]\n\n[![Read the documentation at https://bw_temporalis.readthedocs.io/](https://img.shields.io/readthedocs/bw_temporalis/latest.svg?label=Read%20the%20Docs)][read the docs]\n[![Tests](https://github.com/brightway-lca/bw_temporalis/actions/workflows/python-test.yml/badge.svg)][tests]\n[![Codecov](https://codecov.io/gh/brightway-lca/bw_temporalis/branch/main/graph/badge.svg)][codecov]\n\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]\n[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]\n\n[pypi status]: https://pypi.org/project/bw_temporalis/\n[read the docs]: https://bw_temporalis.readthedocs.io/\n[tests]: https://github.com/brightway-lca/bw_temporalis/actions/workflows/python-test.yml\n[codecov]: https://app.codecov.io/gh/brightway-lca/bw_temporalis\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[black]: https://github.com/psf/black\n\n## Installation\n\nYou can install _bw_temporalis_ via [pip] from [PyPI]:\n\n```console\n$ pip install bw_temporalis\n```\n\nCurrently Python 3.11 installations are broken as [scikit-network](https://scikit-network.readthedocs.io/en/latest/?badge=latest) only has pre-built wheels for version 0.31 - but this changed the [API for shortest path](https://github.com/sknetwork-team/scikit-network/blob/master/HISTORY.rst#0310-2023-05-22), and `bw_graph_tools` has not yet been adapted](https://github.com/brightway-lca/bw_graph_tools/issues/13).\n\nYou can also install using conda in the [cmutel channel](https://anaconda.org/cmutel/bw_temporalis).\n\n## Usage notes\n\nSee [the teaching repo `from-the-ground-up`](https://github.com/brightway-lca/from-the-ground-up/tree/main/temporal) for examples on how to use this library.\n\nThis library uses the *net amount* in the technosphere and biosphere matrix, so caution should be taken in cases where multiple edges with temporal dynamics, especially with different numerical signs, link the same nodes. In general, these edges should be split across multiple processes.\n\nThe temporal resolution should not be less than seconds, it will be rounded up to seconds in the `TemporalDistribution`.\n\n## Contributing\n\nContributions are very welcome.\nTo learn more, see the [Contributor Guide].\n\n## License\n\nDistributed under the terms of the [BSD 3 Clause license][license],\n_bw_temporalis_ is free and open source software.\n\n## Issues\n\nIf you encounter any problems,\nplease [file an issue] along with a detailed description.\n\n\n<!-- github-only -->\n\n[command-line reference]: https://bw_temporalis.readthedocs.io/en/latest/usage.html\n[license]: https://github.com/brightway-lca/bw_temporalis/blob/main/LICENSE\n[contributor guide]: https://github.com/brightway-lca/bw_temporalis/blob/main/CONTRIBUTING.md\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Revision of bw2temporalis for modern Brightway",
    "version": "1.1.1",
    "project_urls": {
        "Homepage": "https://github.com/brightway-lca/bw_temporalis",
        "source": "https://github.com/brightway-lca/bw_temporalis",
        "tracker": "https://github.com/brightway-lca/bw_temporalis/issues"
    },
    "split_keywords": [
        "\"brightway\"",
        " \"development\""
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8dd96aa1499c1215ca7a2ed045e449e369aeec61a324ad01cf2425b2751e147c",
                "md5": "f13543f58bb51b84711c8802d2f77087",
                "sha256": "9d4ae56adff0a13c5461e1953ec1f76064145d0c40618e721fe9ce333adf42b7"
            },
            "downloads": -1,
            "filename": "bw_temporalis-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f13543f58bb51b84711c8802d2f77087",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 24241,
            "upload_time": "2024-06-20T10:20:12",
            "upload_time_iso_8601": "2024-06-20T10:20:12.193196Z",
            "url": "https://files.pythonhosted.org/packages/8d/d9/6aa1499c1215ca7a2ed045e449e369aeec61a324ad01cf2425b2751e147c/bw_temporalis-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0e7c44d842f267a5b97c14b91e491279a88800906f25889e74e37c20064a249a",
                "md5": "bfc0e522f07d131b113b08e7d324c9b4",
                "sha256": "22d53fe7d7c017e97c14f514ec5bb4c17c6a8d7b950c03b5d2525b4c302dff45"
            },
            "downloads": -1,
            "filename": "bw_temporalis-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "bfc0e522f07d131b113b08e7d324c9b4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 34563,
            "upload_time": "2024-06-20T10:20:14",
            "upload_time_iso_8601": "2024-06-20T10:20:14.656047Z",
            "url": "https://files.pythonhosted.org/packages/0e/7c/44d842f267a5b97c14b91e491279a88800906f25889e74e37c20064a249a/bw_temporalis-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-20 10:20:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "brightway-lca",
    "github_project": "bw_temporalis",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "bw-temporalis"
}
        
Elapsed time: 0.31204s