dynamic-characterization 0.0.1__tar.gz → 0.0.1.dev1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,140 @@
1
+ Metadata-Version: 2.1
2
+ Name: dynamic_characterization
3
+ Version: 0.0.1.dev1
4
+ Summary: Collection of dynamic characterization functions for life cycle inventories with temporal information
5
+ Author-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
6
+ Maintainer-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
7
+ Project-URL: source, https://github.com/TimoDiepers/dynamic_characterization
8
+ Project-URL: homepage, https://github.com/TimoDiepers/dynamic_characterization
9
+ Project-URL: tracker, https://github.com/TimoDiepers/dynamic_characterization/issues
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Programming Language :: Python
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Natural Language :: English
18
+ Classifier: Operating System :: OS Independent
19
+ Classifier: Topic :: Scientific/Engineering
20
+ Requires-Python: >=3.9
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE
23
+ Provides-Extra: testing
24
+ Requires-Dist: dynamic_characterization; extra == "testing"
25
+ Requires-Dist: pytest; extra == "testing"
26
+ Requires-Dist: pytest-cov; extra == "testing"
27
+ Requires-Dist: python-coveralls; extra == "testing"
28
+ Provides-Extra: dev
29
+ Requires-Dist: build; extra == "dev"
30
+ Requires-Dist: pre-commit; extra == "dev"
31
+ Requires-Dist: pylint; extra == "dev"
32
+ Requires-Dist: pytest; extra == "dev"
33
+ Requires-Dist: pytest-cov; extra == "dev"
34
+ Requires-Dist: pytest-randomly; extra == "dev"
35
+ Requires-Dist: setuptools; extra == "dev"
36
+
37
+ # dynamic_characterization
38
+
39
+ [![Read the Docs](https://img.shields.io/readthedocs/timex?label=documentation)](https://dynamic-characterization.readthedocs.io/en/latest/)
40
+ [![PyPI - Version](https://img.shields.io/pypi/v/dynamic-characterization?color=%2300549f)](https://pypi.org/project/dynamic-characterization/)
41
+ [![Conda Version](https://img.shields.io/conda/v/diepers/dynamic_characterization?label=conda)](https://anaconda.org/diepers/dynamic_characterization)
42
+ ![Conda - License](https://img.shields.io/conda/l/diepers/bw_timex)
43
+
44
+ This is a collection of dynamic characterization functions for life cycle inventories with temporal information.
45
+
46
+ Here's an overview of what is currently included:
47
+
48
+ | impact category | metric | covered emissions | source
49
+ |-------|----------|----------|--|
50
+ | climate change | radiative forcing | CO2, CH4 |[bw_temporalis](https://github.com/brightway-lca/bw_temporalis/tree/main)|
51
+ | climate change | radiative forcing | 247 GHGs from [IPCC AR6 Ch.7](https://www.ipcc.ch/report/ar6/wg1/chapter/chapter-7/) |[bw_timex](https://github.com/brightway-lca/bw_timex/tree/main)|
52
+
53
+ ## What do dynamic characterization functions do?
54
+
55
+ The functions are meant to work with a common input format of the dynamic inventory, collected in a pandas DataFrame that looks like this:
56
+
57
+ | date | amount | flow | activity |
58
+ |-------|-------|------|----------|
59
+ | 101 | 33 | 1 | 2 |
60
+ | 312 | 21 | 4 | 2 |
61
+
62
+ Each function takes one row of this dynamic inventory dataframe (i.e. one emission at one point in time) and transform it according to some metric. The output generated by applying a very simple function to both rows of the input dataframe could look like:
63
+
64
+ | date | amount | flow | activity |
65
+ |------|--------|------|----------|
66
+ | 101 | 33 | 1 | 2 |
67
+ | 102 | 31 | 1 | 2 |
68
+ | 103 | 31 | 1 | 2 |
69
+ | 312 | 21 | 4 | 2 |
70
+ | 313 | 20 | 4 | 2 |
71
+ | 314 | 19 | 4 | 2 |
72
+
73
+ ## What do dynamic characterization functions look like?
74
+
75
+ Here's an example of what such a function could look like:
76
+
77
+ ```python
78
+ def characterize_something(series, period: int = 100, cumulative=False) -> pd.DataFrame:
79
+ date_beginning: np.datetime64 = series["date"].to_numpy()
80
+ date_characterized: np.ndarray = date_beginning + np.arange(
81
+ start=0, stop=period, dtype="timedelta64[Y]"
82
+ ).astype("timedelta64[s]")
83
+
84
+ decay_multipliers: list = np.array(
85
+ [
86
+ 1.234 * (1 - np.exp(-year / 56.789))
87
+ for year in range(period)
88
+ ]
89
+ )
90
+
91
+ forcing = pd.Series(data=series.amount * decay_multipliers, dtype="float64")
92
+ if not cumulative:
93
+ forcing = forcing.diff(periods=1).fillna(0)
94
+
95
+ return pd.DataFrame(
96
+ {
97
+ "date": pd.Series(data=date_characterized, dtype="datetime64[s]"),
98
+ "amount": forcing,
99
+ "flow": series.flow,
100
+ "activity": series.activity,
101
+ }
102
+ )
103
+ ````
104
+
105
+ ## Installation
106
+
107
+ You can install `dynamic_characterization` via [pip] from [PyPI]:
108
+
109
+ ```console
110
+ $ pip install dynamic_characterization
111
+ ```
112
+
113
+ Alternatively, you can also use conda:
114
+
115
+ ```console
116
+ $ conda install -c diepers dynamic_characterization
117
+ ```
118
+
119
+ ## Contributing
120
+
121
+ Contributions are very welcome.
122
+ To learn more, see the [Contributor Guide][Contributor Guide].
123
+
124
+ ## License
125
+
126
+ Distributed under the terms of the [BSD 3 Clause license][License],
127
+ _dynamic_characterization_ is free and open source software.
128
+
129
+ ## Issues
130
+
131
+ If you encounter any problems,
132
+ please [file an issue][Issue Tracker] along with a detailed description.
133
+
134
+
135
+ <!-- github-only -->
136
+
137
+ [command-line reference]: https://dynamic-characterization.readthedocs.io/en/latest/usage.html
138
+ [License]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/LICENSE
139
+ [Contributor Guide]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/CONTRIBUTING.md
140
+ [Issue Tracker]: https://github.com/TimoDiepers/dynamic_characterization/issues
@@ -0,0 +1,104 @@
1
+ # dynamic_characterization
2
+
3
+ [![Read the Docs](https://img.shields.io/readthedocs/timex?label=documentation)](https://dynamic-characterization.readthedocs.io/en/latest/)
4
+ [![PyPI - Version](https://img.shields.io/pypi/v/dynamic-characterization?color=%2300549f)](https://pypi.org/project/dynamic-characterization/)
5
+ [![Conda Version](https://img.shields.io/conda/v/diepers/dynamic_characterization?label=conda)](https://anaconda.org/diepers/dynamic_characterization)
6
+ ![Conda - License](https://img.shields.io/conda/l/diepers/bw_timex)
7
+
8
+ This is a collection of dynamic characterization functions for life cycle inventories with temporal information.
9
+
10
+ Here's an overview of what is currently included:
11
+
12
+ | impact category | metric | covered emissions | source
13
+ |-------|----------|----------|--|
14
+ | climate change | radiative forcing | CO2, CH4 |[bw_temporalis](https://github.com/brightway-lca/bw_temporalis/tree/main)|
15
+ | climate change | radiative forcing | 247 GHGs from [IPCC AR6 Ch.7](https://www.ipcc.ch/report/ar6/wg1/chapter/chapter-7/) |[bw_timex](https://github.com/brightway-lca/bw_timex/tree/main)|
16
+
17
+ ## What do dynamic characterization functions do?
18
+
19
+ The functions are meant to work with a common input format of the dynamic inventory, collected in a pandas DataFrame that looks like this:
20
+
21
+ | date | amount | flow | activity |
22
+ |-------|-------|------|----------|
23
+ | 101 | 33 | 1 | 2 |
24
+ | 312 | 21 | 4 | 2 |
25
+
26
+ Each function takes one row of this dynamic inventory dataframe (i.e. one emission at one point in time) and transform it according to some metric. The output generated by applying a very simple function to both rows of the input dataframe could look like:
27
+
28
+ | date | amount | flow | activity |
29
+ |------|--------|------|----------|
30
+ | 101 | 33 | 1 | 2 |
31
+ | 102 | 31 | 1 | 2 |
32
+ | 103 | 31 | 1 | 2 |
33
+ | 312 | 21 | 4 | 2 |
34
+ | 313 | 20 | 4 | 2 |
35
+ | 314 | 19 | 4 | 2 |
36
+
37
+ ## What do dynamic characterization functions look like?
38
+
39
+ Here's an example of what such a function could look like:
40
+
41
+ ```python
42
+ def characterize_something(series, period: int = 100, cumulative=False) -> pd.DataFrame:
43
+ date_beginning: np.datetime64 = series["date"].to_numpy()
44
+ date_characterized: np.ndarray = date_beginning + np.arange(
45
+ start=0, stop=period, dtype="timedelta64[Y]"
46
+ ).astype("timedelta64[s]")
47
+
48
+ decay_multipliers: list = np.array(
49
+ [
50
+ 1.234 * (1 - np.exp(-year / 56.789))
51
+ for year in range(period)
52
+ ]
53
+ )
54
+
55
+ forcing = pd.Series(data=series.amount * decay_multipliers, dtype="float64")
56
+ if not cumulative:
57
+ forcing = forcing.diff(periods=1).fillna(0)
58
+
59
+ return pd.DataFrame(
60
+ {
61
+ "date": pd.Series(data=date_characterized, dtype="datetime64[s]"),
62
+ "amount": forcing,
63
+ "flow": series.flow,
64
+ "activity": series.activity,
65
+ }
66
+ )
67
+ ````
68
+
69
+ ## Installation
70
+
71
+ You can install `dynamic_characterization` via [pip] from [PyPI]:
72
+
73
+ ```console
74
+ $ pip install dynamic_characterization
75
+ ```
76
+
77
+ Alternatively, you can also use conda:
78
+
79
+ ```console
80
+ $ conda install -c diepers dynamic_characterization
81
+ ```
82
+
83
+ ## Contributing
84
+
85
+ Contributions are very welcome.
86
+ To learn more, see the [Contributor Guide][Contributor Guide].
87
+
88
+ ## License
89
+
90
+ Distributed under the terms of the [BSD 3 Clause license][License],
91
+ _dynamic_characterization_ is free and open source software.
92
+
93
+ ## Issues
94
+
95
+ If you encounter any problems,
96
+ please [file an issue][Issue Tracker] along with a detailed description.
97
+
98
+
99
+ <!-- github-only -->
100
+
101
+ [command-line reference]: https://dynamic-characterization.readthedocs.io/en/latest/usage.html
102
+ [License]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/LICENSE
103
+ [Contributor Guide]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/CONTRIBUTING.md
104
+ [Issue Tracker]: https://github.com/TimoDiepers/dynamic_characterization/issues
@@ -0,0 +1,15 @@
1
+ """
2
+ Collection of dynamic characterization functions for life cycle inventories with temporal information.
3
+ """
4
+
5
+ __all__ = (
6
+ "__version__",
7
+ "temporalis",
8
+ "timex",
9
+ # Add functions and variables you want exposed in `dynamic_characterization.` namespace here
10
+ )
11
+
12
+ __version__ = "0.0.1dev1"
13
+
14
+ from . import temporalis
15
+ from . import timex
@@ -0,0 +1,140 @@
1
+ Metadata-Version: 2.1
2
+ Name: dynamic_characterization
3
+ Version: 0.0.1.dev1
4
+ Summary: Collection of dynamic characterization functions for life cycle inventories with temporal information
5
+ Author-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
6
+ Maintainer-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
7
+ Project-URL: source, https://github.com/TimoDiepers/dynamic_characterization
8
+ Project-URL: homepage, https://github.com/TimoDiepers/dynamic_characterization
9
+ Project-URL: tracker, https://github.com/TimoDiepers/dynamic_characterization/issues
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Programming Language :: Python
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Natural Language :: English
18
+ Classifier: Operating System :: OS Independent
19
+ Classifier: Topic :: Scientific/Engineering
20
+ Requires-Python: >=3.9
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE
23
+ Provides-Extra: testing
24
+ Requires-Dist: dynamic_characterization; extra == "testing"
25
+ Requires-Dist: pytest; extra == "testing"
26
+ Requires-Dist: pytest-cov; extra == "testing"
27
+ Requires-Dist: python-coveralls; extra == "testing"
28
+ Provides-Extra: dev
29
+ Requires-Dist: build; extra == "dev"
30
+ Requires-Dist: pre-commit; extra == "dev"
31
+ Requires-Dist: pylint; extra == "dev"
32
+ Requires-Dist: pytest; extra == "dev"
33
+ Requires-Dist: pytest-cov; extra == "dev"
34
+ Requires-Dist: pytest-randomly; extra == "dev"
35
+ Requires-Dist: setuptools; extra == "dev"
36
+
37
+ # dynamic_characterization
38
+
39
+ [![Read the Docs](https://img.shields.io/readthedocs/timex?label=documentation)](https://dynamic-characterization.readthedocs.io/en/latest/)
40
+ [![PyPI - Version](https://img.shields.io/pypi/v/dynamic-characterization?color=%2300549f)](https://pypi.org/project/dynamic-characterization/)
41
+ [![Conda Version](https://img.shields.io/conda/v/diepers/dynamic_characterization?label=conda)](https://anaconda.org/diepers/dynamic_characterization)
42
+ ![Conda - License](https://img.shields.io/conda/l/diepers/bw_timex)
43
+
44
+ This is a collection of dynamic characterization functions for life cycle inventories with temporal information.
45
+
46
+ Here's an overview of what is currently included:
47
+
48
+ | impact category | metric | covered emissions | source
49
+ |-------|----------|----------|--|
50
+ | climate change | radiative forcing | CO2, CH4 |[bw_temporalis](https://github.com/brightway-lca/bw_temporalis/tree/main)|
51
+ | climate change | radiative forcing | 247 GHGs from [IPCC AR6 Ch.7](https://www.ipcc.ch/report/ar6/wg1/chapter/chapter-7/) |[bw_timex](https://github.com/brightway-lca/bw_timex/tree/main)|
52
+
53
+ ## What do dynamic characterization functions do?
54
+
55
+ The functions are meant to work with a common input format of the dynamic inventory, collected in a pandas DataFrame that looks like this:
56
+
57
+ | date | amount | flow | activity |
58
+ |-------|-------|------|----------|
59
+ | 101 | 33 | 1 | 2 |
60
+ | 312 | 21 | 4 | 2 |
61
+
62
+ Each function takes one row of this dynamic inventory dataframe (i.e. one emission at one point in time) and transform it according to some metric. The output generated by applying a very simple function to both rows of the input dataframe could look like:
63
+
64
+ | date | amount | flow | activity |
65
+ |------|--------|------|----------|
66
+ | 101 | 33 | 1 | 2 |
67
+ | 102 | 31 | 1 | 2 |
68
+ | 103 | 31 | 1 | 2 |
69
+ | 312 | 21 | 4 | 2 |
70
+ | 313 | 20 | 4 | 2 |
71
+ | 314 | 19 | 4 | 2 |
72
+
73
+ ## What do dynamic characterization functions look like?
74
+
75
+ Here's an example of what such a function could look like:
76
+
77
+ ```python
78
+ def characterize_something(series, period: int = 100, cumulative=False) -> pd.DataFrame:
79
+ date_beginning: np.datetime64 = series["date"].to_numpy()
80
+ date_characterized: np.ndarray = date_beginning + np.arange(
81
+ start=0, stop=period, dtype="timedelta64[Y]"
82
+ ).astype("timedelta64[s]")
83
+
84
+ decay_multipliers: list = np.array(
85
+ [
86
+ 1.234 * (1 - np.exp(-year / 56.789))
87
+ for year in range(period)
88
+ ]
89
+ )
90
+
91
+ forcing = pd.Series(data=series.amount * decay_multipliers, dtype="float64")
92
+ if not cumulative:
93
+ forcing = forcing.diff(periods=1).fillna(0)
94
+
95
+ return pd.DataFrame(
96
+ {
97
+ "date": pd.Series(data=date_characterized, dtype="datetime64[s]"),
98
+ "amount": forcing,
99
+ "flow": series.flow,
100
+ "activity": series.activity,
101
+ }
102
+ )
103
+ ````
104
+
105
+ ## Installation
106
+
107
+ You can install `dynamic_characterization` via [pip] from [PyPI]:
108
+
109
+ ```console
110
+ $ pip install dynamic_characterization
111
+ ```
112
+
113
+ Alternatively, you can also use conda:
114
+
115
+ ```console
116
+ $ conda install -c diepers dynamic_characterization
117
+ ```
118
+
119
+ ## Contributing
120
+
121
+ Contributions are very welcome.
122
+ To learn more, see the [Contributor Guide][Contributor Guide].
123
+
124
+ ## License
125
+
126
+ Distributed under the terms of the [BSD 3 Clause license][License],
127
+ _dynamic_characterization_ is free and open source software.
128
+
129
+ ## Issues
130
+
131
+ If you encounter any problems,
132
+ please [file an issue][Issue Tracker] along with a detailed description.
133
+
134
+
135
+ <!-- github-only -->
136
+
137
+ [command-line reference]: https://dynamic-characterization.readthedocs.io/en/latest/usage.html
138
+ [License]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/LICENSE
139
+ [Contributor Guide]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/CONTRIBUTING.md
140
+ [Issue Tracker]: https://github.com/TimoDiepers/dynamic_characterization/issues
@@ -10,7 +10,7 @@ authors = [
10
10
  maintainers = [
11
11
  { name="Timo Diepers", email="timo.diepers@ltt.rwth-aachen.de" }
12
12
  ]
13
- description = "Collection of dynamic characterization functions for life cycle inventories"
13
+ description = "Collection of dynamic characterization functions for life cycle inventories with temporal information"
14
14
  readme = "README.md"
15
15
  dynamic = ["version"]
16
16
  # Add here all kinds of additional classifiers as defined under
@@ -1,108 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: dynamic_characterization
3
- Version: 0.0.1
4
- Summary: Collection of dynamic characterization functions for life cycle inventories
5
- Author-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
6
- Maintainer-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
7
- Project-URL: source, https://github.com/TimoDiepers/dynamic_characterization
8
- Project-URL: homepage, https://github.com/TimoDiepers/dynamic_characterization
9
- Project-URL: tracker, https://github.com/TimoDiepers/dynamic_characterization/issues
10
- Classifier: Development Status :: 4 - Beta
11
- Classifier: Programming Language :: Python
12
- Classifier: Programming Language :: Python :: 3
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Classifier: Programming Language :: Python :: 3.12
17
- Classifier: Natural Language :: English
18
- Classifier: Operating System :: OS Independent
19
- Classifier: Topic :: Scientific/Engineering
20
- Requires-Python: >=3.9
21
- Description-Content-Type: text/markdown
22
- License-File: LICENSE
23
- Provides-Extra: testing
24
- Requires-Dist: dynamic_characterization; extra == "testing"
25
- Requires-Dist: pytest; extra == "testing"
26
- Requires-Dist: pytest-cov; extra == "testing"
27
- Requires-Dist: python-coveralls; extra == "testing"
28
- Provides-Extra: dev
29
- Requires-Dist: build; extra == "dev"
30
- Requires-Dist: pre-commit; extra == "dev"
31
- Requires-Dist: pylint; extra == "dev"
32
- Requires-Dist: pytest; extra == "dev"
33
- Requires-Dist: pytest-cov; extra == "dev"
34
- Requires-Dist: pytest-randomly; extra == "dev"
35
- Requires-Dist: setuptools; extra == "dev"
36
-
37
- # dynamic_characterization
38
-
39
- [![PyPI](https://img.shields.io/pypi/v/dynamic_characterization.svg)][pypi status]
40
- [![Status](https://img.shields.io/pypi/status/dynamic_characterization.svg)][pypi status]
41
- [![Python Version](https://img.shields.io/pypi/pyversions/dynamic_characterization)][pypi status]
42
- [![License](https://img.shields.io/pypi/l/dynamic_characterization)][license]
43
-
44
- [![Read the documentation at https://dynamic_characterization.readthedocs.io/](https://img.shields.io/readthedocs/dynamic_characterization/latest.svg?label=Read%20the%20Docs)][read the docs]
45
- [![Tests](https://github.com/TimoDiepers/dynamic_characterization/actions/workflows/python-test.yml/badge.svg)][tests]
46
- [![Codecov](https://codecov.io/gh/TimoDiepers/dynamic_characterization/branch/main/graph/badge.svg)][codecov]
47
-
48
- [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
49
- [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
50
-
51
- [pypi status]: https://pypi.org/project/dynamic_characterization/
52
- [read the docs]: https://dynamic_characterization.readthedocs.io/
53
- [tests]: https://github.com/TimoDiepers/dynamic_characterization/actions?workflow=Tests
54
- [codecov]: https://app.codecov.io/gh/TimoDiepers/dynamic_characterization
55
- [pre-commit]: https://github.com/pre-commit/pre-commit
56
- [black]: https://github.com/psf/black
57
-
58
- ## Installation
59
-
60
- You can install _dynamic_characterization_ via [pip] from [PyPI]:
61
-
62
- ```console
63
- $ pip install dynamic_characterization
64
- ```
65
-
66
- ## Contributing
67
-
68
- Contributions are very welcome.
69
- To learn more, see the [Contributor Guide][Contributor Guide].
70
-
71
- ## License
72
-
73
- Distributed under the terms of the [BSD 3 Clause license][License],
74
- _dynamic_characterization_ is free and open source software.
75
-
76
- ## Issues
77
-
78
- If you encounter any problems,
79
- please [file an issue][Issue Tracker] along with a detailed description.
80
-
81
-
82
- <!-- github-only -->
83
-
84
- [command-line reference]: https://dynamic_characterization.readthedocs.io/en/latest/usage.html
85
- [License]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/LICENSE
86
- [Contributor Guide]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/CONTRIBUTING.md
87
- [Issue Tracker]: https://github.com/TimoDiepers/dynamic_characterization/issues
88
-
89
-
90
- ## Building the Documentation
91
-
92
- You can build the documentation locally by installing the documentation Conda environment:
93
-
94
- ```bash
95
- conda env create -f docs/environment.yml
96
- ```
97
-
98
- activating the environment
99
-
100
- ```bash
101
- conda activate sphinx_dynamic_characterization
102
- ```
103
-
104
- and [running the build command](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#sphinx-build):
105
-
106
- ```bash
107
- sphinx-build docs _build/html --builder=html --jobs=auto --write-all; open _build/html/index.html
108
- ```
@@ -1,72 +0,0 @@
1
- # dynamic_characterization
2
-
3
- [![PyPI](https://img.shields.io/pypi/v/dynamic_characterization.svg)][pypi status]
4
- [![Status](https://img.shields.io/pypi/status/dynamic_characterization.svg)][pypi status]
5
- [![Python Version](https://img.shields.io/pypi/pyversions/dynamic_characterization)][pypi status]
6
- [![License](https://img.shields.io/pypi/l/dynamic_characterization)][license]
7
-
8
- [![Read the documentation at https://dynamic_characterization.readthedocs.io/](https://img.shields.io/readthedocs/dynamic_characterization/latest.svg?label=Read%20the%20Docs)][read the docs]
9
- [![Tests](https://github.com/TimoDiepers/dynamic_characterization/actions/workflows/python-test.yml/badge.svg)][tests]
10
- [![Codecov](https://codecov.io/gh/TimoDiepers/dynamic_characterization/branch/main/graph/badge.svg)][codecov]
11
-
12
- [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
13
- [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
14
-
15
- [pypi status]: https://pypi.org/project/dynamic_characterization/
16
- [read the docs]: https://dynamic_characterization.readthedocs.io/
17
- [tests]: https://github.com/TimoDiepers/dynamic_characterization/actions?workflow=Tests
18
- [codecov]: https://app.codecov.io/gh/TimoDiepers/dynamic_characterization
19
- [pre-commit]: https://github.com/pre-commit/pre-commit
20
- [black]: https://github.com/psf/black
21
-
22
- ## Installation
23
-
24
- You can install _dynamic_characterization_ via [pip] from [PyPI]:
25
-
26
- ```console
27
- $ pip install dynamic_characterization
28
- ```
29
-
30
- ## Contributing
31
-
32
- Contributions are very welcome.
33
- To learn more, see the [Contributor Guide][Contributor Guide].
34
-
35
- ## License
36
-
37
- Distributed under the terms of the [BSD 3 Clause license][License],
38
- _dynamic_characterization_ is free and open source software.
39
-
40
- ## Issues
41
-
42
- If you encounter any problems,
43
- please [file an issue][Issue Tracker] along with a detailed description.
44
-
45
-
46
- <!-- github-only -->
47
-
48
- [command-line reference]: https://dynamic_characterization.readthedocs.io/en/latest/usage.html
49
- [License]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/LICENSE
50
- [Contributor Guide]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/CONTRIBUTING.md
51
- [Issue Tracker]: https://github.com/TimoDiepers/dynamic_characterization/issues
52
-
53
-
54
- ## Building the Documentation
55
-
56
- You can build the documentation locally by installing the documentation Conda environment:
57
-
58
- ```bash
59
- conda env create -f docs/environment.yml
60
- ```
61
-
62
- activating the environment
63
-
64
- ```bash
65
- conda activate sphinx_dynamic_characterization
66
- ```
67
-
68
- and [running the build command](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#sphinx-build):
69
-
70
- ```bash
71
- sphinx-build docs _build/html --builder=html --jobs=auto --write-all; open _build/html/index.html
72
- ```
@@ -1,8 +0,0 @@
1
- """dynamic_characterization."""
2
-
3
- __all__ = (
4
- "__version__",
5
- # Add functions and variables you want exposed in `dynamic_characterization.` namespace here
6
- )
7
-
8
- __version__ = "0.0.1"
@@ -1,108 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: dynamic_characterization
3
- Version: 0.0.1
4
- Summary: Collection of dynamic characterization functions for life cycle inventories
5
- Author-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
6
- Maintainer-email: Timo Diepers <timo.diepers@ltt.rwth-aachen.de>
7
- Project-URL: source, https://github.com/TimoDiepers/dynamic_characterization
8
- Project-URL: homepage, https://github.com/TimoDiepers/dynamic_characterization
9
- Project-URL: tracker, https://github.com/TimoDiepers/dynamic_characterization/issues
10
- Classifier: Development Status :: 4 - Beta
11
- Classifier: Programming Language :: Python
12
- Classifier: Programming Language :: Python :: 3
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Classifier: Programming Language :: Python :: 3.12
17
- Classifier: Natural Language :: English
18
- Classifier: Operating System :: OS Independent
19
- Classifier: Topic :: Scientific/Engineering
20
- Requires-Python: >=3.9
21
- Description-Content-Type: text/markdown
22
- License-File: LICENSE
23
- Provides-Extra: testing
24
- Requires-Dist: dynamic_characterization; extra == "testing"
25
- Requires-Dist: pytest; extra == "testing"
26
- Requires-Dist: pytest-cov; extra == "testing"
27
- Requires-Dist: python-coveralls; extra == "testing"
28
- Provides-Extra: dev
29
- Requires-Dist: build; extra == "dev"
30
- Requires-Dist: pre-commit; extra == "dev"
31
- Requires-Dist: pylint; extra == "dev"
32
- Requires-Dist: pytest; extra == "dev"
33
- Requires-Dist: pytest-cov; extra == "dev"
34
- Requires-Dist: pytest-randomly; extra == "dev"
35
- Requires-Dist: setuptools; extra == "dev"
36
-
37
- # dynamic_characterization
38
-
39
- [![PyPI](https://img.shields.io/pypi/v/dynamic_characterization.svg)][pypi status]
40
- [![Status](https://img.shields.io/pypi/status/dynamic_characterization.svg)][pypi status]
41
- [![Python Version](https://img.shields.io/pypi/pyversions/dynamic_characterization)][pypi status]
42
- [![License](https://img.shields.io/pypi/l/dynamic_characterization)][license]
43
-
44
- [![Read the documentation at https://dynamic_characterization.readthedocs.io/](https://img.shields.io/readthedocs/dynamic_characterization/latest.svg?label=Read%20the%20Docs)][read the docs]
45
- [![Tests](https://github.com/TimoDiepers/dynamic_characterization/actions/workflows/python-test.yml/badge.svg)][tests]
46
- [![Codecov](https://codecov.io/gh/TimoDiepers/dynamic_characterization/branch/main/graph/badge.svg)][codecov]
47
-
48
- [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
49
- [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
50
-
51
- [pypi status]: https://pypi.org/project/dynamic_characterization/
52
- [read the docs]: https://dynamic_characterization.readthedocs.io/
53
- [tests]: https://github.com/TimoDiepers/dynamic_characterization/actions?workflow=Tests
54
- [codecov]: https://app.codecov.io/gh/TimoDiepers/dynamic_characterization
55
- [pre-commit]: https://github.com/pre-commit/pre-commit
56
- [black]: https://github.com/psf/black
57
-
58
- ## Installation
59
-
60
- You can install _dynamic_characterization_ via [pip] from [PyPI]:
61
-
62
- ```console
63
- $ pip install dynamic_characterization
64
- ```
65
-
66
- ## Contributing
67
-
68
- Contributions are very welcome.
69
- To learn more, see the [Contributor Guide][Contributor Guide].
70
-
71
- ## License
72
-
73
- Distributed under the terms of the [BSD 3 Clause license][License],
74
- _dynamic_characterization_ is free and open source software.
75
-
76
- ## Issues
77
-
78
- If you encounter any problems,
79
- please [file an issue][Issue Tracker] along with a detailed description.
80
-
81
-
82
- <!-- github-only -->
83
-
84
- [command-line reference]: https://dynamic_characterization.readthedocs.io/en/latest/usage.html
85
- [License]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/LICENSE
86
- [Contributor Guide]: https://github.com/TimoDiepers/dynamic_characterization/blob/main/CONTRIBUTING.md
87
- [Issue Tracker]: https://github.com/TimoDiepers/dynamic_characterization/issues
88
-
89
-
90
- ## Building the Documentation
91
-
92
- You can build the documentation locally by installing the documentation Conda environment:
93
-
94
- ```bash
95
- conda env create -f docs/environment.yml
96
- ```
97
-
98
- activating the environment
99
-
100
- ```bash
101
- conda activate sphinx_dynamic_characterization
102
- ```
103
-
104
- and [running the build command](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#sphinx-build):
105
-
106
- ```bash
107
- sphinx-build docs _build/html --builder=html --jobs=auto --write-all; open _build/html/index.html
108
- ```