fasthep 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.
- fasthep-0.1.0/.flake8 +6 -0
- fasthep-0.1.0/.git_archival.txt +4 -0
- fasthep-0.1.0/.gitattributes +1 -0
- fasthep-0.1.0/.github/CONTRIBUTING.md +101 -0
- fasthep-0.1.0/.github/dependabot.yml +7 -0
- fasthep-0.1.0/.github/matchers/pylint.json +32 -0
- fasthep-0.1.0/.github/workflows/ci.yml +99 -0
- fasthep-0.1.0/.gitignore +141 -0
- fasthep-0.1.0/.pre-commit-config.yaml +110 -0
- fasthep-0.1.0/.readthedocs.yml +21 -0
- fasthep-0.1.0/LICENSE +203 -0
- fasthep-0.1.0/PKG-INFO +113 -0
- fasthep-0.1.0/README.md +56 -0
- fasthep-0.1.0/docs/Makefile +20 -0
- fasthep-0.1.0/docs/conf.py +63 -0
- fasthep-0.1.0/docs/index.rst +24 -0
- fasthep-0.1.0/docs/make.bat +35 -0
- fasthep-0.1.0/noxfile.py +81 -0
- fasthep-0.1.0/pyproject.toml +115 -0
- fasthep-0.1.0/setup.py +47 -0
- fasthep-0.1.0/src/fasthep/__init__.py +12 -0
- fasthep-0.1.0/src/fasthep/py.typed +0 -0
- fasthep-0.1.0/tests/test_package.py +37 -0
fasthep-0.1.0/.flake8
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.git_archival.txt export-subst
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
See the [Scikit-HEP Developer introduction][skhep-dev-intro] for a detailed
|
|
2
|
+
description of best practices for developing Scikit-HEP packages.
|
|
3
|
+
|
|
4
|
+
[skhep-dev-intro]: https://scikit-hep.org/developer/intro
|
|
5
|
+
|
|
6
|
+
# Quick development
|
|
7
|
+
|
|
8
|
+
The fastest way to start with development is to use nox. If you don't have nox,
|
|
9
|
+
you can use `pipx run nox` to run it without installing, or `pipx install nox`.
|
|
10
|
+
If you don't have pipx (pip for applications), then you can install with with
|
|
11
|
+
`pip install pipx` (the only case were installing an application with regular
|
|
12
|
+
pip is reasonable). If you use macOS, then pipx and nox are both in brew, use
|
|
13
|
+
`brew install pipx nox`.
|
|
14
|
+
|
|
15
|
+
To use, run `nox`. This will lint and test using every installed version of
|
|
16
|
+
Python on your system, skipping ones that are not installed. You can also run
|
|
17
|
+
specific jobs:
|
|
18
|
+
|
|
19
|
+
```console
|
|
20
|
+
$ nox -s lint # Lint only
|
|
21
|
+
$ nox -s tests-3.9 # Python 3.9 tests only
|
|
22
|
+
$ nox -s docs -- serve # Build and serve the docs
|
|
23
|
+
$ nox -s build # Make an SDist and wheel
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Nox handles everything for you, including setting up an temporary virtual
|
|
27
|
+
environment for each run.
|
|
28
|
+
|
|
29
|
+
# Setting up a development environment manually
|
|
30
|
+
|
|
31
|
+
You can set up a development environment by running:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
python3 -m venv .venv
|
|
35
|
+
source ./.venv/bin/activate
|
|
36
|
+
pip install -v -e .[dev]
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
If you have the
|
|
40
|
+
[Python Launcher for Unix](https://github.com/brettcannon/python-launcher), you
|
|
41
|
+
can instead do:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
py -m venv .venv
|
|
45
|
+
py -m install -v -e .[dev]
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
# Post setup
|
|
49
|
+
|
|
50
|
+
You should prepare pre-commit, which will help you by checking that commits pass
|
|
51
|
+
required checks:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
pip install pre-commit # or brew install pre-commit on macOS
|
|
55
|
+
pre-commit install # Will install a pre-commit hook into the git repo
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
You can also/alternatively run `pre-commit run` (changes only) or
|
|
59
|
+
`pre-commit run --all-files` to check even without installing the hook.
|
|
60
|
+
|
|
61
|
+
# Testing
|
|
62
|
+
|
|
63
|
+
Use pytest to run the unit checks:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
pytest
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
# Coverage
|
|
70
|
+
|
|
71
|
+
Use pytest-cov to generate coverage reports:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
pytest --cov=fasthep
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
# Building docs
|
|
78
|
+
|
|
79
|
+
You can build the docs using:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
nox -s docs
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
You can see a preview with:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
nox -s docs -- serve
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
# Pre-commit
|
|
92
|
+
|
|
93
|
+
This project uses pre-commit for all style checking. While you can run it with
|
|
94
|
+
nox, this is such an important tool that it deserves to be installed on its own.
|
|
95
|
+
Install pre-commit and run:
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
pre-commit run -a
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
to check all files.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"problemMatcher": [
|
|
3
|
+
{
|
|
4
|
+
"severity": "warning",
|
|
5
|
+
"pattern": [
|
|
6
|
+
{
|
|
7
|
+
"regexp": "^([^:]+):(\\d+):(\\d+): ([A-DF-Z]\\d+): \\033\\[[\\d;]+m([^\\033]+).*$",
|
|
8
|
+
"file": 1,
|
|
9
|
+
"line": 2,
|
|
10
|
+
"column": 3,
|
|
11
|
+
"code": 4,
|
|
12
|
+
"message": 5
|
|
13
|
+
}
|
|
14
|
+
],
|
|
15
|
+
"owner": "pylint-warning"
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"severity": "error",
|
|
19
|
+
"pattern": [
|
|
20
|
+
{
|
|
21
|
+
"regexp": "^([^:]+):(\\d+):(\\d+): (E\\d+): \\033\\[[\\d;]+m([^\\033]+).*$",
|
|
22
|
+
"file": 1,
|
|
23
|
+
"line": 2,
|
|
24
|
+
"column": 3,
|
|
25
|
+
"code": 4,
|
|
26
|
+
"message": 5
|
|
27
|
+
}
|
|
28
|
+
],
|
|
29
|
+
"owner": "pylint-error"
|
|
30
|
+
}
|
|
31
|
+
]
|
|
32
|
+
}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
pull_request:
|
|
6
|
+
push:
|
|
7
|
+
branches:
|
|
8
|
+
- master
|
|
9
|
+
- main
|
|
10
|
+
- develop
|
|
11
|
+
release:
|
|
12
|
+
types:
|
|
13
|
+
- published
|
|
14
|
+
|
|
15
|
+
concurrency:
|
|
16
|
+
group: ${{ github.workflow }}-${{ github.ref }}
|
|
17
|
+
cancel-in-progress: true
|
|
18
|
+
|
|
19
|
+
env:
|
|
20
|
+
FORCE_COLOR: 3
|
|
21
|
+
|
|
22
|
+
jobs:
|
|
23
|
+
pre-commit:
|
|
24
|
+
name: Format
|
|
25
|
+
runs-on: ubuntu-latest
|
|
26
|
+
steps:
|
|
27
|
+
- uses: actions/checkout@v3
|
|
28
|
+
with:
|
|
29
|
+
fetch-depth: 0
|
|
30
|
+
- uses: actions/setup-python@v4
|
|
31
|
+
with:
|
|
32
|
+
python-version: "3.x"
|
|
33
|
+
- uses: pre-commit/action@v3.0.0
|
|
34
|
+
with:
|
|
35
|
+
extra_args: --hook-stage manual --all-files
|
|
36
|
+
- name: Run PyLint
|
|
37
|
+
run: |
|
|
38
|
+
echo "::add-matcher::$GITHUB_WORKSPACE/.github/matchers/pylint.json"
|
|
39
|
+
pipx run nox -s pylint
|
|
40
|
+
|
|
41
|
+
checks:
|
|
42
|
+
name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
|
|
43
|
+
runs-on: ${{ matrix.runs-on }}
|
|
44
|
+
needs: [pre-commit]
|
|
45
|
+
strategy:
|
|
46
|
+
fail-fast: false
|
|
47
|
+
matrix:
|
|
48
|
+
python-version: ["3.8", "3.10"]
|
|
49
|
+
runs-on: [ubuntu-latest, macos-latest, windows-latest]
|
|
50
|
+
|
|
51
|
+
include:
|
|
52
|
+
- python-version: pypy-3.8
|
|
53
|
+
runs-on: ubuntu-latest
|
|
54
|
+
|
|
55
|
+
steps:
|
|
56
|
+
- uses: actions/checkout@v3
|
|
57
|
+
with:
|
|
58
|
+
fetch-depth: 0
|
|
59
|
+
|
|
60
|
+
- uses: actions/setup-python@v4
|
|
61
|
+
with:
|
|
62
|
+
python-version: ${{ matrix.python-version }}
|
|
63
|
+
|
|
64
|
+
- name: Install package
|
|
65
|
+
run: python -m pip install .[test,full]
|
|
66
|
+
|
|
67
|
+
- name: Test package
|
|
68
|
+
run: python -m pytest -ra --cov=fasthep
|
|
69
|
+
|
|
70
|
+
- name: Upload coverage report
|
|
71
|
+
uses: codecov/codecov-action@v3.1.0
|
|
72
|
+
|
|
73
|
+
dist:
|
|
74
|
+
name: Distribution build
|
|
75
|
+
runs-on: ubuntu-latest
|
|
76
|
+
needs: [pre-commit]
|
|
77
|
+
|
|
78
|
+
steps:
|
|
79
|
+
- uses: actions/checkout@v3
|
|
80
|
+
with:
|
|
81
|
+
fetch-depth: 0
|
|
82
|
+
|
|
83
|
+
- name: Build sdist and wheel
|
|
84
|
+
run: pipx run build
|
|
85
|
+
|
|
86
|
+
- uses: actions/upload-artifact@v3
|
|
87
|
+
with:
|
|
88
|
+
path: dist
|
|
89
|
+
|
|
90
|
+
- name: Check products
|
|
91
|
+
run: pipx run twine check dist/*
|
|
92
|
+
|
|
93
|
+
- uses: pypa/gh-action-pypi-publish@v1.8.3
|
|
94
|
+
if: github.event_name == 'release' && github.event.action == 'published'
|
|
95
|
+
with:
|
|
96
|
+
# Remember to generate this and set it in "GitHub Secrets"
|
|
97
|
+
password: ${{ secrets.pypi_password }}
|
|
98
|
+
# Remove this line
|
|
99
|
+
repository_url: https://test.pypi.org/legacy/
|
fasthep-0.1.0/.gitignore
ADDED
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py,cover
|
|
50
|
+
.hypothesis/
|
|
51
|
+
.pytest_cache/
|
|
52
|
+
cover/
|
|
53
|
+
|
|
54
|
+
# Translations
|
|
55
|
+
*.mo
|
|
56
|
+
*.pot
|
|
57
|
+
|
|
58
|
+
# Django stuff:
|
|
59
|
+
*.log
|
|
60
|
+
local_settings.py
|
|
61
|
+
db.sqlite3
|
|
62
|
+
db.sqlite3-journal
|
|
63
|
+
|
|
64
|
+
# Flask stuff:
|
|
65
|
+
instance/
|
|
66
|
+
.webassets-cache
|
|
67
|
+
|
|
68
|
+
# Scrapy stuff:
|
|
69
|
+
.scrapy
|
|
70
|
+
|
|
71
|
+
# Sphinx documentation
|
|
72
|
+
docs/_build/
|
|
73
|
+
|
|
74
|
+
# PyBuilder
|
|
75
|
+
.pybuilder/
|
|
76
|
+
target/
|
|
77
|
+
|
|
78
|
+
# Jupyter Notebook
|
|
79
|
+
.ipynb_checkpoints
|
|
80
|
+
|
|
81
|
+
# IPython
|
|
82
|
+
profile_default/
|
|
83
|
+
ipython_config.py
|
|
84
|
+
|
|
85
|
+
# pyenv
|
|
86
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
87
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
88
|
+
# .python-version
|
|
89
|
+
|
|
90
|
+
# pipenv
|
|
91
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
92
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
93
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
94
|
+
# install all needed dependencies.
|
|
95
|
+
#Pipfile.lock
|
|
96
|
+
|
|
97
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
|
|
98
|
+
__pypackages__/
|
|
99
|
+
|
|
100
|
+
# Celery stuff
|
|
101
|
+
celerybeat-schedule
|
|
102
|
+
celerybeat.pid
|
|
103
|
+
|
|
104
|
+
# SageMath parsed files
|
|
105
|
+
*.sage.py
|
|
106
|
+
|
|
107
|
+
# Environments
|
|
108
|
+
.env
|
|
109
|
+
.venv
|
|
110
|
+
env/
|
|
111
|
+
venv/
|
|
112
|
+
ENV/
|
|
113
|
+
env.bak/
|
|
114
|
+
venv.bak/
|
|
115
|
+
|
|
116
|
+
# Spyder project settings
|
|
117
|
+
.spyderproject
|
|
118
|
+
.spyproject
|
|
119
|
+
|
|
120
|
+
# Rope project settings
|
|
121
|
+
.ropeproject
|
|
122
|
+
|
|
123
|
+
# mkdocs documentation
|
|
124
|
+
/site
|
|
125
|
+
|
|
126
|
+
# mypy
|
|
127
|
+
.mypy_cache/
|
|
128
|
+
.dmypy.json
|
|
129
|
+
dmypy.json
|
|
130
|
+
|
|
131
|
+
# Pyre type checker
|
|
132
|
+
.pyre/
|
|
133
|
+
|
|
134
|
+
# pytype static type analyzer
|
|
135
|
+
.pytype/
|
|
136
|
+
|
|
137
|
+
# Cython debug symbols
|
|
138
|
+
cython_debug/
|
|
139
|
+
|
|
140
|
+
# setuptools_scm
|
|
141
|
+
src/*/_version.py
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
ci:
|
|
2
|
+
autoupdate_commit_msg: "chore: update pre-commit hooks"
|
|
3
|
+
autofix_commit_msg: "style: pre-commit fixes"
|
|
4
|
+
|
|
5
|
+
repos:
|
|
6
|
+
- repo: https://github.com/psf/black
|
|
7
|
+
rev: 22.8.0
|
|
8
|
+
hooks:
|
|
9
|
+
- id: black-jupyter
|
|
10
|
+
|
|
11
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
12
|
+
rev: v4.3.0
|
|
13
|
+
hooks:
|
|
14
|
+
- id: check-added-large-files
|
|
15
|
+
- id: check-case-conflict
|
|
16
|
+
- id: check-merge-conflict
|
|
17
|
+
- id: check-symlinks
|
|
18
|
+
- id: check-yaml
|
|
19
|
+
- id: debug-statements
|
|
20
|
+
- id: end-of-file-fixer
|
|
21
|
+
- id: mixed-line-ending
|
|
22
|
+
- id: name-tests-test
|
|
23
|
+
args: ["--pytest-test-first"]
|
|
24
|
+
- id: requirements-txt-fixer
|
|
25
|
+
- id: trailing-whitespace
|
|
26
|
+
|
|
27
|
+
- repo: https://github.com/pre-commit/pygrep-hooks
|
|
28
|
+
rev: v1.9.0
|
|
29
|
+
hooks:
|
|
30
|
+
- id: python-check-blanket-noqa
|
|
31
|
+
- id: python-check-blanket-type-ignore
|
|
32
|
+
- id: python-no-eval
|
|
33
|
+
- id: python-use-type-annotations
|
|
34
|
+
- id: rst-backticks
|
|
35
|
+
- id: rst-directive-colons
|
|
36
|
+
- id: rst-inline-touching-normal
|
|
37
|
+
|
|
38
|
+
- repo: https://github.com/pre-commit/mirrors-prettier
|
|
39
|
+
rev: "v2.7.1"
|
|
40
|
+
hooks:
|
|
41
|
+
- id: prettier
|
|
42
|
+
types_or: [yaml, markdown, html, css, scss, javascript, json]
|
|
43
|
+
args: [--prose-wrap=always]
|
|
44
|
+
|
|
45
|
+
- repo: https://github.com/asottile/blacken-docs
|
|
46
|
+
rev: v1.12.1
|
|
47
|
+
hooks:
|
|
48
|
+
- id: blacken-docs
|
|
49
|
+
additional_dependencies: [black==22.8.0]
|
|
50
|
+
|
|
51
|
+
- repo: https://github.com/PyCQA/isort
|
|
52
|
+
rev: 5.10.1
|
|
53
|
+
hooks:
|
|
54
|
+
- id: isort
|
|
55
|
+
args: ["-a", "from __future__ import annotations"] # Python 3.7+
|
|
56
|
+
|
|
57
|
+
- repo: https://github.com/asottile/pyupgrade
|
|
58
|
+
rev: v2.37.3
|
|
59
|
+
hooks:
|
|
60
|
+
- id: pyupgrade
|
|
61
|
+
args: ["--py37-plus"]
|
|
62
|
+
|
|
63
|
+
- repo: https://github.com/hadialqattan/pycln
|
|
64
|
+
rev: v2.1.1
|
|
65
|
+
hooks:
|
|
66
|
+
- id: pycln
|
|
67
|
+
additional_dependencies: [click<8.1]
|
|
68
|
+
args: [--all]
|
|
69
|
+
stages: [manual]
|
|
70
|
+
|
|
71
|
+
- repo: https://github.com/asottile/yesqa
|
|
72
|
+
rev: v1.4.0
|
|
73
|
+
hooks:
|
|
74
|
+
- id: yesqa
|
|
75
|
+
exclude: docs/conf.py
|
|
76
|
+
additional_dependencies: &flake8_dependencies
|
|
77
|
+
- flake8-bugbear
|
|
78
|
+
- flake8-print
|
|
79
|
+
|
|
80
|
+
- repo: https://github.com/pycqa/flake8
|
|
81
|
+
rev: 5.0.4
|
|
82
|
+
hooks:
|
|
83
|
+
- id: flake8
|
|
84
|
+
exclude: docs/conf.py
|
|
85
|
+
additional_dependencies: *flake8_dependencies
|
|
86
|
+
|
|
87
|
+
- repo: https://github.com/pre-commit/mirrors-mypy
|
|
88
|
+
rev: v0.971
|
|
89
|
+
hooks:
|
|
90
|
+
- id: mypy
|
|
91
|
+
files: src
|
|
92
|
+
args: []
|
|
93
|
+
|
|
94
|
+
- repo: https://github.com/codespell-project/codespell
|
|
95
|
+
rev: v2.2.1
|
|
96
|
+
hooks:
|
|
97
|
+
- id: codespell
|
|
98
|
+
|
|
99
|
+
- repo: https://github.com/shellcheck-py/shellcheck-py
|
|
100
|
+
rev: v0.8.0.4
|
|
101
|
+
hooks:
|
|
102
|
+
- id: shellcheck
|
|
103
|
+
|
|
104
|
+
- repo: local
|
|
105
|
+
hooks:
|
|
106
|
+
- id: disallow-caps
|
|
107
|
+
name: Disallow improper capitalization
|
|
108
|
+
language: pygrep
|
|
109
|
+
entry: PyBind|Numpy|Cmake|CCache|Github|PyTest
|
|
110
|
+
exclude: .pre-commit-config.yaml
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# .readthedocs.yml
|
|
2
|
+
# Read the Docs configuration file
|
|
3
|
+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
4
|
+
|
|
5
|
+
# Required
|
|
6
|
+
version: 2
|
|
7
|
+
|
|
8
|
+
# Build documentation in the docs/ directory with Sphinx
|
|
9
|
+
sphinx:
|
|
10
|
+
configuration: docs/conf.py
|
|
11
|
+
|
|
12
|
+
# Include PDF and ePub
|
|
13
|
+
formats: all
|
|
14
|
+
|
|
15
|
+
python:
|
|
16
|
+
version: "3.10"
|
|
17
|
+
install:
|
|
18
|
+
- method: pip
|
|
19
|
+
path: .
|
|
20
|
+
extra_requirements:
|
|
21
|
+
- docs
|
fasthep-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
Apache License
|
|
4
|
+
Version 2.0, January 2004
|
|
5
|
+
http://www.apache.org/licenses/
|
|
6
|
+
|
|
7
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
|
+
|
|
9
|
+
1. Definitions.
|
|
10
|
+
|
|
11
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
12
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
13
|
+
|
|
14
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
15
|
+
the copyright owner that is granting the License.
|
|
16
|
+
|
|
17
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
18
|
+
other entities that control, are controlled by, or are under common
|
|
19
|
+
control with that entity. For the purposes of this definition,
|
|
20
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
21
|
+
direction or management of such entity, whether by contract or
|
|
22
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
23
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
24
|
+
|
|
25
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
26
|
+
exercising permissions granted by this License.
|
|
27
|
+
|
|
28
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
29
|
+
including but not limited to software source code, documentation
|
|
30
|
+
source, and configuration files.
|
|
31
|
+
|
|
32
|
+
"Object" form shall mean any form resulting from mechanical
|
|
33
|
+
transformation or translation of a Source form, including but
|
|
34
|
+
not limited to compiled object code, generated documentation,
|
|
35
|
+
and conversions to other media types.
|
|
36
|
+
|
|
37
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
38
|
+
Object form, made available under the License, as indicated by a
|
|
39
|
+
copyright notice that is included in or attached to the work
|
|
40
|
+
(an example is provided in the Appendix below).
|
|
41
|
+
|
|
42
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
43
|
+
form, that is based on (or derived from) the Work and for which the
|
|
44
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
45
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
46
|
+
of this License, Derivative Works shall not include works that remain
|
|
47
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
48
|
+
the Work and Derivative Works thereof.
|
|
49
|
+
|
|
50
|
+
"Contribution" shall mean any work of authorship, including
|
|
51
|
+
the original version of the Work and any modifications or additions
|
|
52
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
53
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
54
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
55
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
56
|
+
means any form of electronic, verbal, or written communication sent
|
|
57
|
+
to the Licensor or its representatives, including but not limited to
|
|
58
|
+
communication on electronic mailing lists, source code control systems,
|
|
59
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
60
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
61
|
+
excluding communication that is conspicuously marked or otherwise
|
|
62
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
63
|
+
|
|
64
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
65
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
66
|
+
subsequently incorporated within the Work.
|
|
67
|
+
|
|
68
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
69
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
70
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
71
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
72
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
73
|
+
Work and such Derivative Works in Source or Object form.
|
|
74
|
+
|
|
75
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
76
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
77
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
78
|
+
(except as stated in this section) patent license to make, have made,
|
|
79
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
80
|
+
where such license applies only to those patent claims licensable
|
|
81
|
+
by such Contributor that are necessarily infringed by their
|
|
82
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
83
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
84
|
+
institute patent litigation against any entity (including a
|
|
85
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
86
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
87
|
+
or contributory patent infringement, then any patent licenses
|
|
88
|
+
granted to You under this License for that Work shall terminate
|
|
89
|
+
as of the date such litigation is filed.
|
|
90
|
+
|
|
91
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
92
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
93
|
+
modifications, and in Source or Object form, provided that You
|
|
94
|
+
meet the following conditions:
|
|
95
|
+
|
|
96
|
+
(a) You must give any other recipients of the Work or
|
|
97
|
+
Derivative Works a copy of this License; and
|
|
98
|
+
|
|
99
|
+
(b) You must cause any modified files to carry prominent notices
|
|
100
|
+
stating that You changed the files; and
|
|
101
|
+
|
|
102
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
103
|
+
that You distribute, all copyright, patent, trademark, and
|
|
104
|
+
attribution notices from the Source form of the Work,
|
|
105
|
+
excluding those notices that do not pertain to any part of
|
|
106
|
+
the Derivative Works; and
|
|
107
|
+
|
|
108
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
109
|
+
distribution, then any Derivative Works that You distribute must
|
|
110
|
+
include a readable copy of the attribution notices contained
|
|
111
|
+
within such NOTICE file, excluding those notices that do not
|
|
112
|
+
pertain to any part of the Derivative Works, in at least one
|
|
113
|
+
of the following places: within a NOTICE text file distributed
|
|
114
|
+
as part of the Derivative Works; within the Source form or
|
|
115
|
+
documentation, if provided along with the Derivative Works; or,
|
|
116
|
+
within a display generated by the Derivative Works, if and
|
|
117
|
+
wherever such third-party notices normally appear. The contents
|
|
118
|
+
of the NOTICE file are for informational purposes only and
|
|
119
|
+
do not modify the License. You may add Your own attribution
|
|
120
|
+
notices within Derivative Works that You distribute, alongside
|
|
121
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
122
|
+
that such additional attribution notices cannot be construed
|
|
123
|
+
as modifying the License.
|
|
124
|
+
|
|
125
|
+
You may add Your own copyright statement to Your modifications and
|
|
126
|
+
may provide additional or different license terms and conditions
|
|
127
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
128
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
129
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
130
|
+
the conditions stated in this License.
|
|
131
|
+
|
|
132
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
133
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
134
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
135
|
+
this License, without any additional terms or conditions.
|
|
136
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
137
|
+
the terms of any separate license agreement you may have executed
|
|
138
|
+
with Licensor regarding such Contributions.
|
|
139
|
+
|
|
140
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
141
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
142
|
+
except as required for reasonable and customary use in describing the
|
|
143
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
144
|
+
|
|
145
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
146
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
147
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
148
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
149
|
+
implied, including, without limitation, any warranties or conditions
|
|
150
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
151
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
152
|
+
appropriateness of using or redistributing the Work and assume any
|
|
153
|
+
risks associated with Your exercise of permissions under this License.
|
|
154
|
+
|
|
155
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
156
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
157
|
+
unless required by applicable law (such as deliberate and grossly
|
|
158
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
159
|
+
liable to You for damages, including any direct, indirect, special,
|
|
160
|
+
incidental, or consequential damages of any character arising as a
|
|
161
|
+
result of this License or out of the use or inability to use the
|
|
162
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
163
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
164
|
+
other commercial damages or losses), even if such Contributor
|
|
165
|
+
has been advised of the possibility of such damages.
|
|
166
|
+
|
|
167
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
168
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
169
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
170
|
+
or other liability obligations and/or rights consistent with this
|
|
171
|
+
License. However, in accepting such obligations, You may act only
|
|
172
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
173
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
174
|
+
defend, and hold each Contributor harmless for any liability
|
|
175
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
176
|
+
of your accepting any such warranty or additional liability.
|
|
177
|
+
|
|
178
|
+
END OF TERMS AND CONDITIONS
|
|
179
|
+
|
|
180
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
181
|
+
|
|
182
|
+
To apply the Apache License to your work, attach the following
|
|
183
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
184
|
+
replaced with your own identifying information. (Don't include
|
|
185
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
186
|
+
comment syntax for the file format. We also recommend that a
|
|
187
|
+
file or class name and description of purpose be included on the
|
|
188
|
+
same "printed page" as the copyright notice for easier
|
|
189
|
+
identification within third-party archives.
|
|
190
|
+
|
|
191
|
+
Copyright 2022 Luke Kreczko
|
|
192
|
+
|
|
193
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
194
|
+
you may not use this file except in compliance with the License.
|
|
195
|
+
You may obtain a copy of the License at
|
|
196
|
+
|
|
197
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
|
+
|
|
199
|
+
Unless required by applicable law or agreed to in writing, software
|
|
200
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
201
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
202
|
+
See the License for the specific language governing permissions and
|
|
203
|
+
limitations under the License.
|
fasthep-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: fasthep
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A meta package for the FAST-HEP toolkit
|
|
5
|
+
Author-email: Luke Kreczko <fast-hep@cern.ch>
|
|
6
|
+
Requires-Python: >=3.7
|
|
7
|
+
Description-Content-Type: text/markdown
|
|
8
|
+
Classifier: Development Status :: 1 - Planning
|
|
9
|
+
Classifier: Intended Audience :: Science/Research
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Programming Language :: Python
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
20
|
+
Classifier: Topic :: Scientific/Engineering
|
|
21
|
+
Classifier: Typing :: Typed
|
|
22
|
+
Requires-Dist: fasthep-cli
|
|
23
|
+
Requires-Dist: fasthep-logging
|
|
24
|
+
Requires-Dist: typing_extensions >=3.7; python_version<'3.8'
|
|
25
|
+
Requires-Dist: fast-carpenter ; extra == "carpenter"
|
|
26
|
+
Requires-Dist: fast-curator ; extra == "carpenter"
|
|
27
|
+
Requires-Dist: fast-flow ; extra == "carpenter"
|
|
28
|
+
Requires-Dist: pytest >=6 ; extra == "dev"
|
|
29
|
+
Requires-Dist: pytest-cov >=3 ; extra == "dev"
|
|
30
|
+
Requires-Dist: pre-commit ; extra == "dev"
|
|
31
|
+
Requires-Dist: mypy >=0.971 ; extra == "dev"
|
|
32
|
+
Requires-Dist: Sphinx>=4.0 ; extra == "docs"
|
|
33
|
+
Requires-Dist: myst_parser>=0.13 ; extra == "docs"
|
|
34
|
+
Requires-Dist: sphinx-book-theme>=0.1.0 ; extra == "docs"
|
|
35
|
+
Requires-Dist: sphinx_copybutton ; extra == "docs"
|
|
36
|
+
Requires-Dist: fast-carpenter ; extra == "full"
|
|
37
|
+
Requires-Dist: fast-curator ; extra == "full"
|
|
38
|
+
Requires-Dist: fast-flow ; extra == "full"
|
|
39
|
+
Requires-Dist: fast-plotter ; extra == "full"
|
|
40
|
+
Requires-Dist: scikit-validate ; extra == "full"
|
|
41
|
+
Requires-Dist: fast-plotter ; extra == "plot"
|
|
42
|
+
Requires-Dist: pytest >=6 ; extra == "test"
|
|
43
|
+
Requires-Dist: pytest-cov >=3 ; extra == "test"
|
|
44
|
+
Requires-Dist: scikit-validate ; extra == "validate"
|
|
45
|
+
Project-URL: Bug Tracker, https://github.com/FAST-HEP/fasthep/issues
|
|
46
|
+
Project-URL: Changelog, https://github.com/FAST-HEP/fasthep/releases
|
|
47
|
+
Project-URL: Discussions, https://github.com/FAST-HEP/fasthep/discussions
|
|
48
|
+
Project-URL: Homepage, https://github.com/FAST-HEP/fasthep
|
|
49
|
+
Provides-Extra: carpenter
|
|
50
|
+
Provides-Extra: dev
|
|
51
|
+
Provides-Extra: docs
|
|
52
|
+
Provides-Extra: full
|
|
53
|
+
Provides-Extra: plot
|
|
54
|
+
Provides-Extra: test
|
|
55
|
+
Provides-Extra: validate
|
|
56
|
+
|
|
57
|
+
# fasthep
|
|
58
|
+
|
|
59
|
+
[![Actions Status][actions-badge]][actions-link]
|
|
60
|
+
[![Documentation Status][rtd-badge]][rtd-link]
|
|
61
|
+
|
|
62
|
+
[![PyPI version][pypi-version]][pypi-link]
|
|
63
|
+
[![PyPI platforms][pypi-platforms]][pypi-link]
|
|
64
|
+
|
|
65
|
+
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
|
|
66
|
+
[![Gitter][gitter-badge]][gitter-link]
|
|
67
|
+
|
|
68
|
+
FAST-HEP provides tools for analysis of high-energy physics data. It is designed
|
|
69
|
+
to be used in conjunction [SciKit-HEP](https://scikit-hep.org/) packages such as
|
|
70
|
+
[uproot](https://github.com/scikit-hep/uproot5) and
|
|
71
|
+
[awkward-array](https://github.com/scikit-hep/awkward) and more. On the data
|
|
72
|
+
processing side it leverages [Numba](https://numba.pydata.org/) and
|
|
73
|
+
[Cupy](https://cupy.dev/) to provide fast and efficient implementations of
|
|
74
|
+
common analysis tasks. For distributed computing, Dask is used as the primary
|
|
75
|
+
backend.
|
|
76
|
+
|
|
77
|
+
## Installation
|
|
78
|
+
|
|
79
|
+
The meta-package `fasthep` can be installed via `pip` or `conda`:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
pip install fasthep
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
by default, this will install only the core packages such as the FAST-HEP CLI
|
|
86
|
+
and logging packages. To install the full package, including the optional
|
|
87
|
+
dependencies, use:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
pip install fasthep[full]
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
You can also cherry-picker the optional dependencies you want to install:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
pip install fasthep[plotting, carpenter, validate]
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
<!-- prettier-ignore-start -->
|
|
100
|
+
[actions-badge]: https://github.com/FAST-HEP/fasthep/workflows/CI/badge.svg
|
|
101
|
+
[actions-link]: https://github.com/FAST-HEP/fasthep/actions
|
|
102
|
+
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
|
|
103
|
+
[github-discussions-link]: https://github.com/orgs/FAST-HEP/discussions
|
|
104
|
+
[gitter-badge]: https://badges.gitter.im/FAST-HEP/community.svg
|
|
105
|
+
[gitter-link]: https://gitter.im/FAST-HEP/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
|
|
106
|
+
[pypi-link]: https://pypi.org/project/fasthep/
|
|
107
|
+
[pypi-platforms]: https://img.shields.io/pypi/pyversions/fasthep
|
|
108
|
+
[pypi-version]: https://img.shields.io/pypi/v/fasthep
|
|
109
|
+
[rtd-badge]: https://readthedocs.org/projects/fasthep/badge/?version=latest
|
|
110
|
+
[rtd-link]: https://fasthep.readthedocs.io/en/latest/?badge=latest
|
|
111
|
+
|
|
112
|
+
<!-- prettier-ignore-end -->
|
|
113
|
+
|
fasthep-0.1.0/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# fasthep
|
|
2
|
+
|
|
3
|
+
[![Actions Status][actions-badge]][actions-link]
|
|
4
|
+
[![Documentation Status][rtd-badge]][rtd-link]
|
|
5
|
+
|
|
6
|
+
[![PyPI version][pypi-version]][pypi-link]
|
|
7
|
+
[![PyPI platforms][pypi-platforms]][pypi-link]
|
|
8
|
+
|
|
9
|
+
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
|
|
10
|
+
[![Gitter][gitter-badge]][gitter-link]
|
|
11
|
+
|
|
12
|
+
FAST-HEP provides tools for analysis of high-energy physics data. It is designed
|
|
13
|
+
to be used in conjunction [SciKit-HEP](https://scikit-hep.org/) packages such as
|
|
14
|
+
[uproot](https://github.com/scikit-hep/uproot5) and
|
|
15
|
+
[awkward-array](https://github.com/scikit-hep/awkward) and more. On the data
|
|
16
|
+
processing side it leverages [Numba](https://numba.pydata.org/) and
|
|
17
|
+
[Cupy](https://cupy.dev/) to provide fast and efficient implementations of
|
|
18
|
+
common analysis tasks. For distributed computing, Dask is used as the primary
|
|
19
|
+
backend.
|
|
20
|
+
|
|
21
|
+
## Installation
|
|
22
|
+
|
|
23
|
+
The meta-package `fasthep` can be installed via `pip` or `conda`:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
pip install fasthep
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
by default, this will install only the core packages such as the FAST-HEP CLI
|
|
30
|
+
and logging packages. To install the full package, including the optional
|
|
31
|
+
dependencies, use:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
pip install fasthep[full]
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
You can also cherry-picker the optional dependencies you want to install:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
pip install fasthep[plotting, carpenter, validate]
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
<!-- prettier-ignore-start -->
|
|
44
|
+
[actions-badge]: https://github.com/FAST-HEP/fasthep/workflows/CI/badge.svg
|
|
45
|
+
[actions-link]: https://github.com/FAST-HEP/fasthep/actions
|
|
46
|
+
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
|
|
47
|
+
[github-discussions-link]: https://github.com/orgs/FAST-HEP/discussions
|
|
48
|
+
[gitter-badge]: https://badges.gitter.im/FAST-HEP/community.svg
|
|
49
|
+
[gitter-link]: https://gitter.im/FAST-HEP/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
|
|
50
|
+
[pypi-link]: https://pypi.org/project/fasthep/
|
|
51
|
+
[pypi-platforms]: https://img.shields.io/pypi/pyversions/fasthep
|
|
52
|
+
[pypi-version]: https://img.shields.io/pypi/v/fasthep
|
|
53
|
+
[rtd-badge]: https://readthedocs.org/projects/fasthep/badge/?version=latest
|
|
54
|
+
[rtd-link]: https://fasthep.readthedocs.io/en/latest/?badge=latest
|
|
55
|
+
|
|
56
|
+
<!-- prettier-ignore-end -->
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Minimal makefile for Sphinx documentation
|
|
2
|
+
#
|
|
3
|
+
|
|
4
|
+
# You can set these variables from the command line, and also
|
|
5
|
+
# from the environment for the first two.
|
|
6
|
+
SPHINXOPTS ?=
|
|
7
|
+
SPHINXBUILD ?= sphinx-build
|
|
8
|
+
SOURCEDIR = .
|
|
9
|
+
BUILDDIR = build
|
|
10
|
+
|
|
11
|
+
# Put it first so that "make" without argument is like "make help".
|
|
12
|
+
help:
|
|
13
|
+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
14
|
+
|
|
15
|
+
.PHONY: help Makefile
|
|
16
|
+
|
|
17
|
+
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
18
|
+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
19
|
+
%: Makefile
|
|
20
|
+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Configuration file for the Sphinx documentation builder.
|
|
2
|
+
#
|
|
3
|
+
# This file only contains a selection of the most common options. For a full
|
|
4
|
+
# list see the documentation:
|
|
5
|
+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
6
|
+
|
|
7
|
+
from __future__ import annotations
|
|
8
|
+
|
|
9
|
+
# Warning: do not change the path here. To use autodoc, you need to install the
|
|
10
|
+
# package first.
|
|
11
|
+
|
|
12
|
+
# -- Project information -----------------------------------------------------
|
|
13
|
+
|
|
14
|
+
project = "fasthep"
|
|
15
|
+
copyright = "2022, Luke Kreczko"
|
|
16
|
+
author = "Luke Kreczko"
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
# -- General configuration ---------------------------------------------------
|
|
20
|
+
|
|
21
|
+
# Add any Sphinx extension module names here, as strings. They can be
|
|
22
|
+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
23
|
+
# ones.
|
|
24
|
+
extensions = [
|
|
25
|
+
"myst_parser",
|
|
26
|
+
"sphinx.ext.autodoc",
|
|
27
|
+
"sphinx.ext.mathjax",
|
|
28
|
+
"sphinx.ext.napoleon",
|
|
29
|
+
"sphinx_copybutton",
|
|
30
|
+
]
|
|
31
|
+
|
|
32
|
+
# Add any paths that contain templates here, relative to this directory.
|
|
33
|
+
templates_path = []
|
|
34
|
+
|
|
35
|
+
# List of patterns, relative to source directory, that match files and
|
|
36
|
+
# directories to ignore when looking for source files.
|
|
37
|
+
# This pattern also affects html_static_path and html_extra_path.
|
|
38
|
+
exclude_patterns = ["_build", "**.ipynb_checkpoints", "Thumbs.db", ".DS_Store", ".env"]
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
# -- Options for HTML output -------------------------------------------------
|
|
42
|
+
|
|
43
|
+
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
44
|
+
# a list of builtin themes.
|
|
45
|
+
#
|
|
46
|
+
html_theme = "sphinx_book_theme"
|
|
47
|
+
|
|
48
|
+
html_title = f"{project}"
|
|
49
|
+
|
|
50
|
+
html_baseurl = "https://fasthep.readthedocs.io/en/latest/"
|
|
51
|
+
|
|
52
|
+
html_theme_options = {
|
|
53
|
+
"home_page_in_toc": True,
|
|
54
|
+
"repository_url": "https://github.com/FAST-HEP/fasthep",
|
|
55
|
+
"use_repository_button": True,
|
|
56
|
+
"use_issues_button": True,
|
|
57
|
+
"use_edit_page_button": True,
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
# Add any paths that contain custom static files (such as style sheets) here,
|
|
61
|
+
# relative to this directory. They are copied after the builtin static files,
|
|
62
|
+
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
63
|
+
html_static_path: list[str] = []
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
|
|
2
|
+
Welcome to documentation!
|
|
3
|
+
=========================
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
Introduction
|
|
7
|
+
------------
|
|
8
|
+
|
|
9
|
+
This should be updated!
|
|
10
|
+
|
|
11
|
+
.. toctree::
|
|
12
|
+
:maxdepth: 2
|
|
13
|
+
:titlesonly:
|
|
14
|
+
:caption: Contents
|
|
15
|
+
:glob:
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
Indices and tables
|
|
20
|
+
==================
|
|
21
|
+
|
|
22
|
+
* :ref:`genindex`
|
|
23
|
+
* :ref:`modindex`
|
|
24
|
+
* :ref:`search`
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
@ECHO OFF
|
|
2
|
+
|
|
3
|
+
pushd %~dp0
|
|
4
|
+
|
|
5
|
+
REM Command file for Sphinx documentation
|
|
6
|
+
|
|
7
|
+
if "%SPHINXBUILD%" == "" (
|
|
8
|
+
set SPHINXBUILD=sphinx-build
|
|
9
|
+
)
|
|
10
|
+
set SOURCEDIR=.
|
|
11
|
+
set BUILDDIR=build
|
|
12
|
+
|
|
13
|
+
if "%1" == "" goto help
|
|
14
|
+
|
|
15
|
+
%SPHINXBUILD% >NUL 2>NUL
|
|
16
|
+
if errorlevel 9009 (
|
|
17
|
+
echo.
|
|
18
|
+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
|
19
|
+
echo.installed, then set the SPHINXBUILD environment variable to point
|
|
20
|
+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
|
21
|
+
echo.may add the Sphinx directory to PATH.
|
|
22
|
+
echo.
|
|
23
|
+
echo.If you don't have Sphinx installed, grab it from
|
|
24
|
+
echo.http://sphinx-doc.org/
|
|
25
|
+
exit /b 1
|
|
26
|
+
)
|
|
27
|
+
|
|
28
|
+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
29
|
+
goto end
|
|
30
|
+
|
|
31
|
+
:help
|
|
32
|
+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
|
33
|
+
|
|
34
|
+
:end
|
|
35
|
+
popd
|
fasthep-0.1.0/noxfile.py
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import shutil
|
|
4
|
+
from pathlib import Path
|
|
5
|
+
|
|
6
|
+
import nox
|
|
7
|
+
|
|
8
|
+
DIR = Path(__file__).parent.resolve()
|
|
9
|
+
|
|
10
|
+
nox.options.sessions = ["lint", "pylint", "tests"]
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
@nox.session
|
|
14
|
+
def lint(session: nox.Session) -> None:
|
|
15
|
+
"""
|
|
16
|
+
Run the linter.
|
|
17
|
+
"""
|
|
18
|
+
session.install("pre-commit")
|
|
19
|
+
session.run("pre-commit", "run", "--all-files", *session.posargs)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
@nox.session
|
|
23
|
+
def pylint(session: nox.Session) -> None:
|
|
24
|
+
"""
|
|
25
|
+
Run PyLint.
|
|
26
|
+
"""
|
|
27
|
+
# This needs to be installed into the package environment, and is slower
|
|
28
|
+
# than a pre-commit check
|
|
29
|
+
session.install(".", "pylint")
|
|
30
|
+
session.run("pylint", "src", *session.posargs)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
@nox.session
|
|
34
|
+
def tests(session: nox.Session) -> None:
|
|
35
|
+
"""
|
|
36
|
+
Run the unit and regular tests.
|
|
37
|
+
"""
|
|
38
|
+
session.install(".[test]")
|
|
39
|
+
session.run("pytest", *session.posargs)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
@nox.session
|
|
43
|
+
def coverage(session: nox.Session) -> None:
|
|
44
|
+
"""
|
|
45
|
+
Run tests and compute coverage.
|
|
46
|
+
"""
|
|
47
|
+
|
|
48
|
+
session.posargs.append("--cov=fasthep")
|
|
49
|
+
tests(session)
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
@nox.session
|
|
53
|
+
def docs(session: nox.Session) -> None:
|
|
54
|
+
"""
|
|
55
|
+
Build the docs. Pass "serve" to serve.
|
|
56
|
+
"""
|
|
57
|
+
|
|
58
|
+
session.install(".[docs]")
|
|
59
|
+
session.chdir("docs")
|
|
60
|
+
session.run("sphinx-build", "-M", "html", ".", "_build")
|
|
61
|
+
|
|
62
|
+
if session.posargs:
|
|
63
|
+
if "serve" in session.posargs:
|
|
64
|
+
print("Launching docs at http://localhost:8000/ - use Ctrl-C to quit")
|
|
65
|
+
session.run("python", "-m", "http.server", "8000", "-d", "_build/html")
|
|
66
|
+
else:
|
|
67
|
+
session.warn("Unsupported argument to docs")
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
@nox.session
|
|
71
|
+
def build(session: nox.Session) -> None:
|
|
72
|
+
"""
|
|
73
|
+
Build an SDist and wheel.
|
|
74
|
+
"""
|
|
75
|
+
|
|
76
|
+
build_p = DIR.joinpath("build")
|
|
77
|
+
if build_p.exists():
|
|
78
|
+
shutil.rmtree(build_p)
|
|
79
|
+
|
|
80
|
+
session.install("build")
|
|
81
|
+
session.run("python", "-m", "build")
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["flit_core >=3.4"]
|
|
3
|
+
build-backend = "flit_core.buildapi"
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
[project]
|
|
7
|
+
name = "fasthep"
|
|
8
|
+
authors = [
|
|
9
|
+
{ name = "Luke Kreczko", email = "fast-hep@cern.ch" },
|
|
10
|
+
]
|
|
11
|
+
description = "A meta package for the FAST-HEP toolkit"
|
|
12
|
+
readme = "README.md"
|
|
13
|
+
requires-python = ">=3.7"
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Development Status :: 1 - Planning",
|
|
16
|
+
"Intended Audience :: Science/Research",
|
|
17
|
+
"Intended Audience :: Developers",
|
|
18
|
+
"License :: OSI Approved :: Apache Software License",
|
|
19
|
+
"Operating System :: OS Independent",
|
|
20
|
+
"Programming Language :: Python",
|
|
21
|
+
"Programming Language :: Python :: 3",
|
|
22
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
23
|
+
"Programming Language :: Python :: 3.7",
|
|
24
|
+
"Programming Language :: Python :: 3.8",
|
|
25
|
+
"Programming Language :: Python :: 3.9",
|
|
26
|
+
"Programming Language :: Python :: 3.10",
|
|
27
|
+
"Topic :: Scientific/Engineering",
|
|
28
|
+
"Typing :: Typed",
|
|
29
|
+
]
|
|
30
|
+
dynamic = ["version"]
|
|
31
|
+
dependencies = [
|
|
32
|
+
"fasthep-cli",
|
|
33
|
+
"fasthep-logging",
|
|
34
|
+
"typing_extensions >=3.7; python_version<'3.8'",
|
|
35
|
+
]
|
|
36
|
+
|
|
37
|
+
[project.optional-dependencies]
|
|
38
|
+
plot = [
|
|
39
|
+
"fast-plotter",
|
|
40
|
+
]
|
|
41
|
+
carpenter = [
|
|
42
|
+
"fast-carpenter",
|
|
43
|
+
"fast-curator",
|
|
44
|
+
"fast-flow",
|
|
45
|
+
]
|
|
46
|
+
validate = [
|
|
47
|
+
"scikit-validate",
|
|
48
|
+
]
|
|
49
|
+
full = [
|
|
50
|
+
"fast-carpenter",
|
|
51
|
+
"fast-curator",
|
|
52
|
+
"fast-flow",
|
|
53
|
+
"fast-plotter",
|
|
54
|
+
"scikit-validate",
|
|
55
|
+
]
|
|
56
|
+
test = [
|
|
57
|
+
"pytest >=6",
|
|
58
|
+
"pytest-cov >=3",
|
|
59
|
+
]
|
|
60
|
+
dev = [
|
|
61
|
+
"pytest >=6",
|
|
62
|
+
"pytest-cov >=3",
|
|
63
|
+
"pre-commit",
|
|
64
|
+
"mypy >=0.971",
|
|
65
|
+
]
|
|
66
|
+
docs = [
|
|
67
|
+
"Sphinx>=4.0",
|
|
68
|
+
"myst_parser>=0.13",
|
|
69
|
+
"sphinx-book-theme>=0.1.0",
|
|
70
|
+
"sphinx_copybutton",
|
|
71
|
+
]
|
|
72
|
+
|
|
73
|
+
[project.urls]
|
|
74
|
+
Homepage = "https://github.com/FAST-HEP/fasthep"
|
|
75
|
+
"Bug Tracker" = "https://github.com/FAST-HEP/fasthep/issues"
|
|
76
|
+
Discussions = "https://github.com/FAST-HEP/fasthep/discussions"
|
|
77
|
+
Changelog = "https://github.com/FAST-HEP/fasthep/releases"
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
[tool.pytest.ini_options]
|
|
81
|
+
minversion = "6.0"
|
|
82
|
+
addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"]
|
|
83
|
+
xfail_strict = true
|
|
84
|
+
filterwarnings = ["error"]
|
|
85
|
+
log_cli_level = "INFO"
|
|
86
|
+
testpaths = [
|
|
87
|
+
"tests",
|
|
88
|
+
]
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
[tool.mypy]
|
|
92
|
+
files = "src"
|
|
93
|
+
python_version = "3.8"
|
|
94
|
+
warn_unused_configs = true
|
|
95
|
+
strict = true
|
|
96
|
+
show_error_codes = true
|
|
97
|
+
enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
|
|
98
|
+
warn_unreachable = true
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
[tool.isort]
|
|
102
|
+
profile = "black"
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
[tool.pylint]
|
|
106
|
+
master.py-version = "3.8"
|
|
107
|
+
master.ignore-paths= ["src/fasthep/_version.py"]
|
|
108
|
+
reports.output-format = "colorized"
|
|
109
|
+
similarities.ignore-imports = "yes"
|
|
110
|
+
messages_control.disable = [
|
|
111
|
+
"design",
|
|
112
|
+
"fixme",
|
|
113
|
+
"line-too-long",
|
|
114
|
+
"wrong-import-position",
|
|
115
|
+
]
|
fasthep-0.1.0/setup.py
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
#!/usr/bin/env python
|
|
2
|
+
# setup.py generated by flit for tools that don't yet use PEP 517
|
|
3
|
+
|
|
4
|
+
from distutils.core import setup
|
|
5
|
+
|
|
6
|
+
packages = \
|
|
7
|
+
['fasthep']
|
|
8
|
+
|
|
9
|
+
package_data = \
|
|
10
|
+
{'': ['*']}
|
|
11
|
+
|
|
12
|
+
package_dir = \
|
|
13
|
+
{'': 'src'}
|
|
14
|
+
|
|
15
|
+
install_requires = \
|
|
16
|
+
['fasthep-cli', 'fasthep-logging']
|
|
17
|
+
|
|
18
|
+
extras_require = \
|
|
19
|
+
{":python_version<'3.8'": ['typing_extensions >=3.7'],
|
|
20
|
+
'carpenter': ['fast-carpenter', 'fast-curator', 'fast-flow'],
|
|
21
|
+
'dev': ['pytest >=6', 'pytest-cov >=3', 'pre-commit', 'mypy >=0.971'],
|
|
22
|
+
'docs': ['Sphinx>=4.0',
|
|
23
|
+
'myst_parser>=0.13',
|
|
24
|
+
'sphinx-book-theme>=0.1.0',
|
|
25
|
+
'sphinx_copybutton'],
|
|
26
|
+
'full': ['fast-carpenter',
|
|
27
|
+
'fast-curator',
|
|
28
|
+
'fast-flow',
|
|
29
|
+
'fast-plotter',
|
|
30
|
+
'scikit-validate'],
|
|
31
|
+
'plot': ['fast-plotter'],
|
|
32
|
+
'test': ['pytest >=6', 'pytest-cov >=3'],
|
|
33
|
+
'validate': ['scikit-validate']}
|
|
34
|
+
|
|
35
|
+
setup(name='fasthep',
|
|
36
|
+
version='0.1.0',
|
|
37
|
+
description='A meta package for the FAST-HEP toolkit',
|
|
38
|
+
author=None,
|
|
39
|
+
author_email='Luke Kreczko <fast-hep@cern.ch>',
|
|
40
|
+
url=None,
|
|
41
|
+
packages=packages,
|
|
42
|
+
package_data=package_data,
|
|
43
|
+
package_dir=package_dir,
|
|
44
|
+
install_requires=install_requires,
|
|
45
|
+
extras_require=extras_require,
|
|
46
|
+
python_requires='>=3.7',
|
|
47
|
+
)
|
|
File without changes
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import fasthep as m
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
def test_version():
|
|
7
|
+
assert m.__version__
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def test_import_carpenter():
|
|
11
|
+
import fast_carpenter as fc
|
|
12
|
+
|
|
13
|
+
assert fc.__version__
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
def test_import_curator():
|
|
17
|
+
import fast_curator as fc
|
|
18
|
+
|
|
19
|
+
assert fc.__version__
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
def test_import_flow():
|
|
23
|
+
import fast_flow as ff
|
|
24
|
+
|
|
25
|
+
assert ff.__version__
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
def test_import_plotter():
|
|
29
|
+
import fast_plotter as fp
|
|
30
|
+
|
|
31
|
+
assert fp.__version__
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
def test_import_validate():
|
|
35
|
+
import skvalidate
|
|
36
|
+
|
|
37
|
+
assert skvalidate.__version__
|