tbkit 0.2.0__tar.gz → 0.2.1__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.
Files changed (31) hide show
  1. {tbkit-0.2.0/tbkit.egg-info → tbkit-0.2.1}/PKG-INFO +13 -2
  2. {tbkit-0.2.0 → tbkit-0.2.1}/README.md +12 -1
  3. {tbkit-0.2.0 → tbkit-0.2.1}/pyproject.toml +1 -1
  4. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit/__init__.py +1 -1
  5. {tbkit-0.2.0 → tbkit-0.2.1/tbkit.egg-info}/PKG-INFO +13 -2
  6. {tbkit-0.2.0 → tbkit-0.2.1}/LICENSE +0 -0
  7. {tbkit-0.2.0 → tbkit-0.2.1}/setup.cfg +0 -0
  8. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit/dos.py +0 -0
  9. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit/error_handling.py +0 -0
  10. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit/graphene.py +0 -0
  11. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit/kspace.py +0 -0
  12. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit/lattice.py +0 -0
  13. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit/lattices.py +0 -0
  14. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit/plot.py +0 -0
  15. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit/propagation.py +0 -0
  16. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit/save.py +0 -0
  17. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit/system.py +0 -0
  18. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit.egg-info/SOURCES.txt +0 -0
  19. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit.egg-info/dependency_links.txt +0 -0
  20. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit.egg-info/requires.txt +0 -0
  21. {tbkit-0.2.0 → tbkit-0.2.1}/tbkit.egg-info/top_level.txt +0 -0
  22. {tbkit-0.2.0 → tbkit-0.2.1}/tests/test_dos.py +0 -0
  23. {tbkit-0.2.0 → tbkit-0.2.1}/tests/test_error_handling.py +0 -0
  24. {tbkit-0.2.0 → tbkit-0.2.1}/tests/test_graphene.py +0 -0
  25. {tbkit-0.2.0 → tbkit-0.2.1}/tests/test_kspace.py +0 -0
  26. {tbkit-0.2.0 → tbkit-0.2.1}/tests/test_lattice.py +0 -0
  27. {tbkit-0.2.0 → tbkit-0.2.1}/tests/test_lattices.py +0 -0
  28. {tbkit-0.2.0 → tbkit-0.2.1}/tests/test_plot.py +0 -0
  29. {tbkit-0.2.0 → tbkit-0.2.1}/tests/test_propagation.py +0 -0
  30. {tbkit-0.2.0 → tbkit-0.2.1}/tests/test_save.py +0 -0
  31. {tbkit-0.2.0 → tbkit-0.2.1}/tests/test_system.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: tbkit
3
- Version: 0.2.0
3
+ Version: 0.2.1
4
4
  Summary: A Python package to build and solve Tight-Binding models, for research and education.
5
5
  Author-email: Charles Poli <cpoli374@gmail.com>
6
6
  License-Expression: BSD-3-Clause
@@ -27,11 +27,12 @@ Dynamic: license-file
27
27
  # tbkit — a Tight-Binding package for research and education
28
28
 
29
29
  [![tests](https://github.com/cpoli/tbkit/actions/workflows/tests.yml/badge.svg)](https://github.com/cpoli/tbkit/actions/workflows/tests.yml)
30
+ [![coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](https://cpoli.github.io/tbkit/coverage/)
30
31
  [![docs](https://img.shields.io/badge/docs-cpoli.github.io%2Ftbkit-blue.svg)](https://cpoli.github.io/tbkit/)
31
32
  [![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](pyproject.toml)
32
33
  [![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](LICENSE)
33
34
 
34
- ![tbkit logo](docs/source/_static/image/tbkit_logo.png)
35
+ ![tbkit logo](https://raw.githubusercontent.com/cpoli/tbkit/master/docs/source/_static/image/tbkit_logo.png)
35
36
 
36
37
  **tbkit** is a Python package to build and solve Tight-Binding models, written
37
38
  in vectorized NumPy/SciPy. It aims to make the mechanics of Tight-Binding
@@ -85,6 +86,13 @@ research prototyping.
85
86
 
86
87
  Requires Python >= 3.10.
87
88
 
89
+ ```bash
90
+ pip install tbkit
91
+ ```
92
+
93
+ or, for an editable install from a clone (e.g. to run the test suite or
94
+ work on tbkit itself):
95
+
88
96
  ```bash
89
97
  git clone https://github.com/cpoli/tbkit
90
98
  cd tbkit
@@ -98,6 +106,9 @@ pip install -e ".[test]"
98
106
  pytest tests/
99
107
  ```
100
108
 
109
+ The test suite has 100% line coverage of the `tbkit` package; see the
110
+ [HTML coverage report](https://cpoli.github.io/tbkit/coverage/).
111
+
101
112
  ## Quick start
102
113
 
103
114
  Real-space flake, nearest-neighbor square lattice:
@@ -1,11 +1,12 @@
1
1
  # tbkit — a Tight-Binding package for research and education
2
2
 
3
3
  [![tests](https://github.com/cpoli/tbkit/actions/workflows/tests.yml/badge.svg)](https://github.com/cpoli/tbkit/actions/workflows/tests.yml)
4
+ [![coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](https://cpoli.github.io/tbkit/coverage/)
4
5
  [![docs](https://img.shields.io/badge/docs-cpoli.github.io%2Ftbkit-blue.svg)](https://cpoli.github.io/tbkit/)
5
6
  [![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](pyproject.toml)
6
7
  [![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](LICENSE)
7
8
 
8
- ![tbkit logo](docs/source/_static/image/tbkit_logo.png)
9
+ ![tbkit logo](https://raw.githubusercontent.com/cpoli/tbkit/master/docs/source/_static/image/tbkit_logo.png)
9
10
 
10
11
  **tbkit** is a Python package to build and solve Tight-Binding models, written
11
12
  in vectorized NumPy/SciPy. It aims to make the mechanics of Tight-Binding
@@ -59,6 +60,13 @@ research prototyping.
59
60
 
60
61
  Requires Python >= 3.10.
61
62
 
63
+ ```bash
64
+ pip install tbkit
65
+ ```
66
+
67
+ or, for an editable install from a clone (e.g. to run the test suite or
68
+ work on tbkit itself):
69
+
62
70
  ```bash
63
71
  git clone https://github.com/cpoli/tbkit
64
72
  cd tbkit
@@ -72,6 +80,9 @@ pip install -e ".[test]"
72
80
  pytest tests/
73
81
  ```
74
82
 
83
+ The test suite has 100% line coverage of the `tbkit` package; see the
84
+ [HTML coverage report](https://cpoli.github.io/tbkit/coverage/).
85
+
75
86
  ## Quick start
76
87
 
77
88
  Real-space flake, nearest-neighbor square lattice:
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "tbkit"
7
- version = "0.2.0"
7
+ version = "0.2.1"
8
8
  description = "A Python package to build and solve Tight-Binding models, for research and education."
9
9
  readme = "README.md"
10
10
  license = "BSD-3-Clause"
@@ -6,7 +6,7 @@
6
6
 
7
7
  """tbkit: build and solve Tight-Binding models."""
8
8
 
9
- __version__ = "0.2.0"
9
+ __version__ = "0.2.1"
10
10
 
11
11
  __all__ = [
12
12
  "Lattice", "System", "Plot", "Propagation", "Save", "KSpace",
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: tbkit
3
- Version: 0.2.0
3
+ Version: 0.2.1
4
4
  Summary: A Python package to build and solve Tight-Binding models, for research and education.
5
5
  Author-email: Charles Poli <cpoli374@gmail.com>
6
6
  License-Expression: BSD-3-Clause
@@ -27,11 +27,12 @@ Dynamic: license-file
27
27
  # tbkit — a Tight-Binding package for research and education
28
28
 
29
29
  [![tests](https://github.com/cpoli/tbkit/actions/workflows/tests.yml/badge.svg)](https://github.com/cpoli/tbkit/actions/workflows/tests.yml)
30
+ [![coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](https://cpoli.github.io/tbkit/coverage/)
30
31
  [![docs](https://img.shields.io/badge/docs-cpoli.github.io%2Ftbkit-blue.svg)](https://cpoli.github.io/tbkit/)
31
32
  [![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](pyproject.toml)
32
33
  [![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](LICENSE)
33
34
 
34
- ![tbkit logo](docs/source/_static/image/tbkit_logo.png)
35
+ ![tbkit logo](https://raw.githubusercontent.com/cpoli/tbkit/master/docs/source/_static/image/tbkit_logo.png)
35
36
 
36
37
  **tbkit** is a Python package to build and solve Tight-Binding models, written
37
38
  in vectorized NumPy/SciPy. It aims to make the mechanics of Tight-Binding
@@ -85,6 +86,13 @@ research prototyping.
85
86
 
86
87
  Requires Python >= 3.10.
87
88
 
89
+ ```bash
90
+ pip install tbkit
91
+ ```
92
+
93
+ or, for an editable install from a clone (e.g. to run the test suite or
94
+ work on tbkit itself):
95
+
88
96
  ```bash
89
97
  git clone https://github.com/cpoli/tbkit
90
98
  cd tbkit
@@ -98,6 +106,9 @@ pip install -e ".[test]"
98
106
  pytest tests/
99
107
  ```
100
108
 
109
+ The test suite has 100% line coverage of the `tbkit` package; see the
110
+ [HTML coverage report](https://cpoli.github.io/tbkit/coverage/).
111
+
101
112
  ## Quick start
102
113
 
103
114
  Real-space flake, nearest-neighbor square lattice:
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes