pyvlasiator 0.1.0__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.
Potentially problematic release.
This version of pyvlasiator might be problematic. Click here for more details.
- pyvlasiator-0.1.0/LICENSE.md +21 -0
- pyvlasiator-0.1.0/PKG-INFO +61 -0
- pyvlasiator-0.1.0/README.md +43 -0
- pyvlasiator-0.1.0/pyproject.toml +28 -0
- pyvlasiator-0.1.0/src/pyvlasiator/__init__.py +0 -0
- pyvlasiator-0.1.0/src/pyvlasiator/plot/__init__.py +14 -0
- pyvlasiator-0.1.0/src/pyvlasiator/plot/plot.py +1115 -0
- pyvlasiator-0.1.0/src/pyvlasiator/pyvlasiator.py +2 -0
- pyvlasiator-0.1.0/src/pyvlasiator/vlsv/__init__.py +7 -0
- pyvlasiator-0.1.0/src/pyvlasiator/vlsv/reader.py +959 -0
- pyvlasiator-0.1.0/src/pyvlasiator/vlsv/variables.py +187 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Hongyang Zhou <hyzhou@umich.edu> and contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: pyvlasiator
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary:
|
|
5
|
+
Author: Hongyang Zhou
|
|
6
|
+
Author-email: hyzhou@umich.edu
|
|
7
|
+
Requires-Python: >=3.11,<4.0
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
12
|
+
Provides-Extra: plot
|
|
13
|
+
Requires-Dist: matplotlib (>=3.7.2,<4.0.0) ; extra == "plot"
|
|
14
|
+
Requires-Dist: numpy (>=1.25.1,<2.0.0)
|
|
15
|
+
Requires-Dist: pytest-benchmark (>=4.0.0,<5.0.0)
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
|
|
18
|
+
# pyvlasiator
|
|
19
|
+
|
|
20
|
+
<p align="center">
|
|
21
|
+
<a href="https://github.com/henry2004y/pyvlasiator/actions">
|
|
22
|
+
<img src="https://github.com/henry2004y/pyvlasiator/actions/workflows/CI.yml/badge.svg">
|
|
23
|
+
</a>
|
|
24
|
+
<a href="https://henry2004y.github.io/pyvlasiator/">
|
|
25
|
+
<img src="https://img.shields.io/badge/docs-dev-blue">
|
|
26
|
+
</a>
|
|
27
|
+
<a href="LICENSE">
|
|
28
|
+
<img src="https://img.shields.io/badge/license-MIT-blue">
|
|
29
|
+
</a>
|
|
30
|
+
<a href="https://app.codecov.io/gh/henry2004y/pyvlasiator/">
|
|
31
|
+
<img src="https://img.shields.io/codecov/c/github/henry2004y/pyvlasiator">
|
|
32
|
+
</a>
|
|
33
|
+
</p>
|
|
34
|
+
|
|
35
|
+
Lightweight Python package for processing Vlasiator data.
|
|
36
|
+
|
|
37
|
+
## Installation
|
|
38
|
+
|
|
39
|
+
`pyvlasiator` can be installed via
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
$ pip install pyvlasiator
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Usage
|
|
46
|
+
|
|
47
|
+
`pyvlasiator` can be used to process VLSV files generated from Vlasiator.
|
|
48
|
+
|
|
49
|
+
```python
|
|
50
|
+
from pyvlasiator.vlsv import Vlsv
|
|
51
|
+
|
|
52
|
+
file = "test.vlsv"
|
|
53
|
+
meta = Vlsv(file)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Plotting is supported via Matplotlib. For more detailed usage, please refer to the [documentation](https://henry2004y.github.io/pyvlasiator/).
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
`pyvlasiator` was created by Hongyang Zhou. It is licensed under the terms of the MIT license.
|
|
61
|
+
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# pyvlasiator
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<a href="https://github.com/henry2004y/pyvlasiator/actions">
|
|
5
|
+
<img src="https://github.com/henry2004y/pyvlasiator/actions/workflows/CI.yml/badge.svg">
|
|
6
|
+
</a>
|
|
7
|
+
<a href="https://henry2004y.github.io/pyvlasiator/">
|
|
8
|
+
<img src="https://img.shields.io/badge/docs-dev-blue">
|
|
9
|
+
</a>
|
|
10
|
+
<a href="LICENSE">
|
|
11
|
+
<img src="https://img.shields.io/badge/license-MIT-blue">
|
|
12
|
+
</a>
|
|
13
|
+
<a href="https://app.codecov.io/gh/henry2004y/pyvlasiator/">
|
|
14
|
+
<img src="https://img.shields.io/codecov/c/github/henry2004y/pyvlasiator">
|
|
15
|
+
</a>
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
Lightweight Python package for processing Vlasiator data.
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
`pyvlasiator` can be installed via
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
$ pip install pyvlasiator
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
`pyvlasiator` can be used to process VLSV files generated from Vlasiator.
|
|
31
|
+
|
|
32
|
+
```python
|
|
33
|
+
from pyvlasiator.vlsv import Vlsv
|
|
34
|
+
|
|
35
|
+
file = "test.vlsv"
|
|
36
|
+
meta = Vlsv(file)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Plotting is supported via Matplotlib. For more detailed usage, please refer to the [documentation](https://henry2004y.github.io/pyvlasiator/).
|
|
40
|
+
|
|
41
|
+
## License
|
|
42
|
+
|
|
43
|
+
`pyvlasiator` was created by Hongyang Zhou. It is licensed under the terms of the MIT license.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[tool.poetry]
|
|
2
|
+
name = "pyvlasiator"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = ""
|
|
5
|
+
authors = ["Hongyang Zhou <hyzhou@umich.edu>"]
|
|
6
|
+
readme = "README.md"
|
|
7
|
+
|
|
8
|
+
[tool.poetry.dependencies]
|
|
9
|
+
python = "^3.11"
|
|
10
|
+
numpy = "^1.25.1"
|
|
11
|
+
matplotlib = {version = "^3.7.2", optional = true}
|
|
12
|
+
pytest-benchmark = "^4.0.0"
|
|
13
|
+
|
|
14
|
+
[tool.poetry.extras]
|
|
15
|
+
plot = ["matplotlib"]
|
|
16
|
+
|
|
17
|
+
[tool.poetry.group.dev.dependencies]
|
|
18
|
+
pytest = "^7.4.0"
|
|
19
|
+
pytest-cov = "^4.1.0"
|
|
20
|
+
requests = "^2.31.0"
|
|
21
|
+
jupyter = "^1.0.0"
|
|
22
|
+
myst-nb = "^1.0.0"
|
|
23
|
+
sphinx-autoapi = "^3.0.0"
|
|
24
|
+
sphinx-rtd-theme = "^1.2.2"
|
|
25
|
+
|
|
26
|
+
[build-system]
|
|
27
|
+
requires = ["poetry-core"]
|
|
28
|
+
build-backend = "poetry.core.masonry.api"
|
|
File without changes
|