tailpype 0.0.7__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.
- tailpype-0.0.7/LICENSE.txt +19 -0
- tailpype-0.0.7/PKG-INFO +199 -0
- tailpype-0.0.7/README.md +184 -0
- tailpype-0.0.7/pyproject.toml +24 -0
- tailpype-0.0.7/setup.cfg +4 -0
- tailpype-0.0.7/src/tailpype/__init__.py +3 -0
- tailpype-0.0.7/src/tailpype/example.py +6 -0
- tailpype-0.0.7/src/tailpype/ftir/__init__.py +0 -0
- tailpype-0.0.7/src/tailpype/ftir/read_write_spectra.py +63 -0
- tailpype-0.0.7/src/tailpype/read_meas.py +0 -0
- tailpype-0.0.7/src/tailpype.egg-info/PKG-INFO +199 -0
- tailpype-0.0.7/src/tailpype.egg-info/SOURCES.txt +12 -0
- tailpype-0.0.7/src/tailpype.egg-info/dependency_links.txt +1 -0
- tailpype-0.0.7/src/tailpype.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
Copyright (c) 2018 The Python Packaging Authority
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
4
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
5
|
+
in the Software without restriction, including without limitation the rights
|
|
6
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
7
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
8
|
+
furnished to do so, subject to the following conditions:
|
|
9
|
+
|
|
10
|
+
The above copyright notice and this permission notice shall be included in all
|
|
11
|
+
copies or substantial portions of the Software.
|
|
12
|
+
|
|
13
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
14
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
15
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
16
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
17
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
18
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
19
|
+
SOFTWARE.
|
tailpype-0.0.7/PKG-INFO
ADDED
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: tailpype
|
|
3
|
+
Version: 0.0.7
|
|
4
|
+
Summary: A toolbox for the analysis of emissions of internal combustion engines.
|
|
5
|
+
Author-email: Pierre Paschinger <ppaschinger@gmx.at>
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://test.pypi.org/manage/account/
|
|
8
|
+
Project-URL: Issues, https://test.pypi.org/manage/account/
|
|
9
|
+
Classifier: Programming Language :: Python :: 3
|
|
10
|
+
Classifier: Operating System :: OS Independent
|
|
11
|
+
Requires-Python: >=3.12
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE.txt
|
|
14
|
+
Dynamic: license-file
|
|
15
|
+
|
|
16
|
+
# tailpype
|
|
17
|
+
|
|
18
|
+
## Table of Contents
|
|
19
|
+
- [Introduction](#introduction)
|
|
20
|
+
- [Getting started](#getting-started)
|
|
21
|
+
- [Building, uploading, and installing the package](#building-uploading-and-installing-the-package)
|
|
22
|
+
- [The modules](#the-modules)
|
|
23
|
+
- [engine](#engine)
|
|
24
|
+
- [ftir](#ftir)
|
|
25
|
+
- [read_meas](#read_meas)
|
|
26
|
+
- [Tests](#tests)
|
|
27
|
+
- [References](#references)
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## Introduction
|
|
39
|
+
|
|
40
|
+
## License
|
|
41
|
+
|
|
42
|
+
## Getting started
|
|
43
|
+
|
|
44
|
+
## Building, uploading, and installing the package
|
|
45
|
+
|
|
46
|
+
The steps needed to make a new build of a Python package, to upload it to (Test)PyPI, and to install it are described in this section. The information has been taken from the part 'Packaging Python Projects' of [1]. A sample Python project/package can be downloaded from [2]. This has not been done for tailpipe but the project structure has been studied as a reference.
|
|
47
|
+
First of all, it is a good idea to have the latest versions of pip (package manager) and twine (utility for publishing Python packages) installed. This can be achieved with the following commands:
|
|
48
|
+
```
|
|
49
|
+
py -m pip install --upgrade pip
|
|
50
|
+
py -m pip install --upgrade twine
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
To create a new build of the package, use
|
|
54
|
+
```
|
|
55
|
+
py -m build
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
To upload the build to (Test)PyPI, type
|
|
59
|
+
```
|
|
60
|
+
py -m twine upload --repository testpypi dist/*
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
You need an API token to finish this process. API tokens can be created in the account settings of your (Test)PyPI account. Logging in to the (Test)PyPI account requires two-factor authentication: the first is username/password, the second is the Authenticator app. If the error message below occurs, it might help to clear the 'dist' folder:
|
|
64
|
+
```
|
|
65
|
+
"ERROR HTTPError: 400 Bad Request from https://test.pypi.org/legacy/
|
|
66
|
+
File already exists. See https://test.pypi.org/help/#file-name-reuse for more information."
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
To install a build of the package example-package use
|
|
70
|
+
```
|
|
71
|
+
py -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-package
|
|
72
|
+
```
|
|
73
|
+
If a specific version, e.g., 1.2.3. is needed, use
|
|
74
|
+
```
|
|
75
|
+
py -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-package==1.2.3
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
If the package is located in PyPI, the usual way with using pip can also be used to install a build.
|
|
79
|
+
|
|
80
|
+
## The modules
|
|
81
|
+
|
|
82
|
+
### engine
|
|
83
|
+
|
|
84
|
+
### ftir
|
|
85
|
+
|
|
86
|
+
### read_meas
|
|
87
|
+
|
|
88
|
+
## Tests
|
|
89
|
+
|
|
90
|
+
## Release notes
|
|
91
|
+
|
|
92
|
+
- 0.0.1 - 0.0.x: Development builds to be published on TestPyPI
|
|
93
|
+
- 1.0.0: First build to be published on PyPI
|
|
94
|
+
|
|
95
|
+
## References
|
|
96
|
+
|
|
97
|
+
1. “Python Packaging User Guide.” Accessed: Mar. 10, 2026. [Online]. Available: https://packaging.python.org/en/latest/
|
|
98
|
+
|
|
99
|
+
1. “A sample Python project.” Accessed: Mar. 10, 2026. [Online]. Available: https://github.com/pypa/sampleproject
|
|
100
|
+
|
|
101
|
+
1. B. Klein, Einführung in Python 3: Für Ein- und Umsteiger, 4th ed. München,: Carl Hanser Fachbuchverlag, 2021.
|
|
102
|
+
|
|
103
|
+
1. B. Klein, Numerisches Python: Arbeiten mit NumPy, Matplotlib und Pandas. München,: Carl Hanser Fachbuchverlag, 2019.
|
|
104
|
+
|
|
105
|
+
1. D. Hillard, Publishing Python Packages: Test, Share, and Automate Your Projects. Shelter Island: Manning Publications Co., 2023.
|
|
106
|
+
|
|
107
|
+
1. “PEP 8 – Style Guide for Python Code.” [Online]. Available: https://peps.python.org/pep-0008/
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
## Getting started
|
|
112
|
+
|
|
113
|
+
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
|
114
|
+
|
|
115
|
+
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
|
116
|
+
|
|
117
|
+
## Add your files
|
|
118
|
+
|
|
119
|
+
* [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
|
120
|
+
* [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
cd existing_repo
|
|
124
|
+
git remote add origin https://ci.tno.nl/gitlab/STL/tailpype.git
|
|
125
|
+
git branch -M main
|
|
126
|
+
git push -uf origin main
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Integrate with your tools
|
|
130
|
+
|
|
131
|
+
* [Set up project integrations](https://ci.tno.nl/gitlab/STL/tailpype/-/settings/integrations)
|
|
132
|
+
|
|
133
|
+
## Collaborate with your team
|
|
134
|
+
|
|
135
|
+
* [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
|
136
|
+
* [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
|
137
|
+
* [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
|
138
|
+
* [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
|
139
|
+
* [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
|
|
140
|
+
|
|
141
|
+
## Test and Deploy
|
|
142
|
+
|
|
143
|
+
Use the built-in continuous integration in GitLab.
|
|
144
|
+
|
|
145
|
+
* [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
|
|
146
|
+
* [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
|
147
|
+
* [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
|
148
|
+
* [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
|
149
|
+
* [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
|
150
|
+
|
|
151
|
+
***
|
|
152
|
+
|
|
153
|
+
# Editing this README
|
|
154
|
+
|
|
155
|
+
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
|
156
|
+
|
|
157
|
+
## Suggestions for a good README
|
|
158
|
+
|
|
159
|
+
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
|
160
|
+
|
|
161
|
+
## Name
|
|
162
|
+
Choose a self-explaining name for your project.
|
|
163
|
+
|
|
164
|
+
## Description
|
|
165
|
+
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
|
166
|
+
|
|
167
|
+
## Badges
|
|
168
|
+
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
|
169
|
+
|
|
170
|
+
## Visuals
|
|
171
|
+
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
|
172
|
+
|
|
173
|
+
## Installation
|
|
174
|
+
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
|
175
|
+
|
|
176
|
+
## Usage
|
|
177
|
+
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
|
178
|
+
|
|
179
|
+
## Support
|
|
180
|
+
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
|
181
|
+
|
|
182
|
+
## Roadmap
|
|
183
|
+
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
184
|
+
|
|
185
|
+
## Contributing
|
|
186
|
+
State if you are open to contributions and what your requirements are for accepting them.
|
|
187
|
+
|
|
188
|
+
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
|
189
|
+
|
|
190
|
+
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
|
191
|
+
|
|
192
|
+
## Authors and acknowledgment
|
|
193
|
+
Show your appreciation to those who have contributed to the project.
|
|
194
|
+
|
|
195
|
+
## License
|
|
196
|
+
For open source projects, say how it is licensed.
|
|
197
|
+
|
|
198
|
+
## Project status
|
|
199
|
+
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
tailpype-0.0.7/README.md
ADDED
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
# tailpype
|
|
2
|
+
|
|
3
|
+
## Table of Contents
|
|
4
|
+
- [Introduction](#introduction)
|
|
5
|
+
- [Getting started](#getting-started)
|
|
6
|
+
- [Building, uploading, and installing the package](#building-uploading-and-installing-the-package)
|
|
7
|
+
- [The modules](#the-modules)
|
|
8
|
+
- [engine](#engine)
|
|
9
|
+
- [ftir](#ftir)
|
|
10
|
+
- [read_meas](#read_meas)
|
|
11
|
+
- [Tests](#tests)
|
|
12
|
+
- [References](#references)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## Introduction
|
|
24
|
+
|
|
25
|
+
## License
|
|
26
|
+
|
|
27
|
+
## Getting started
|
|
28
|
+
|
|
29
|
+
## Building, uploading, and installing the package
|
|
30
|
+
|
|
31
|
+
The steps needed to make a new build of a Python package, to upload it to (Test)PyPI, and to install it are described in this section. The information has been taken from the part 'Packaging Python Projects' of [1]. A sample Python project/package can be downloaded from [2]. This has not been done for tailpipe but the project structure has been studied as a reference.
|
|
32
|
+
First of all, it is a good idea to have the latest versions of pip (package manager) and twine (utility for publishing Python packages) installed. This can be achieved with the following commands:
|
|
33
|
+
```
|
|
34
|
+
py -m pip install --upgrade pip
|
|
35
|
+
py -m pip install --upgrade twine
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
To create a new build of the package, use
|
|
39
|
+
```
|
|
40
|
+
py -m build
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
To upload the build to (Test)PyPI, type
|
|
44
|
+
```
|
|
45
|
+
py -m twine upload --repository testpypi dist/*
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
You need an API token to finish this process. API tokens can be created in the account settings of your (Test)PyPI account. Logging in to the (Test)PyPI account requires two-factor authentication: the first is username/password, the second is the Authenticator app. If the error message below occurs, it might help to clear the 'dist' folder:
|
|
49
|
+
```
|
|
50
|
+
"ERROR HTTPError: 400 Bad Request from https://test.pypi.org/legacy/
|
|
51
|
+
File already exists. See https://test.pypi.org/help/#file-name-reuse for more information."
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
To install a build of the package example-package use
|
|
55
|
+
```
|
|
56
|
+
py -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-package
|
|
57
|
+
```
|
|
58
|
+
If a specific version, e.g., 1.2.3. is needed, use
|
|
59
|
+
```
|
|
60
|
+
py -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-package==1.2.3
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
If the package is located in PyPI, the usual way with using pip can also be used to install a build.
|
|
64
|
+
|
|
65
|
+
## The modules
|
|
66
|
+
|
|
67
|
+
### engine
|
|
68
|
+
|
|
69
|
+
### ftir
|
|
70
|
+
|
|
71
|
+
### read_meas
|
|
72
|
+
|
|
73
|
+
## Tests
|
|
74
|
+
|
|
75
|
+
## Release notes
|
|
76
|
+
|
|
77
|
+
- 0.0.1 - 0.0.x: Development builds to be published on TestPyPI
|
|
78
|
+
- 1.0.0: First build to be published on PyPI
|
|
79
|
+
|
|
80
|
+
## References
|
|
81
|
+
|
|
82
|
+
1. “Python Packaging User Guide.” Accessed: Mar. 10, 2026. [Online]. Available: https://packaging.python.org/en/latest/
|
|
83
|
+
|
|
84
|
+
1. “A sample Python project.” Accessed: Mar. 10, 2026. [Online]. Available: https://github.com/pypa/sampleproject
|
|
85
|
+
|
|
86
|
+
1. B. Klein, Einführung in Python 3: Für Ein- und Umsteiger, 4th ed. München,: Carl Hanser Fachbuchverlag, 2021.
|
|
87
|
+
|
|
88
|
+
1. B. Klein, Numerisches Python: Arbeiten mit NumPy, Matplotlib und Pandas. München,: Carl Hanser Fachbuchverlag, 2019.
|
|
89
|
+
|
|
90
|
+
1. D. Hillard, Publishing Python Packages: Test, Share, and Automate Your Projects. Shelter Island: Manning Publications Co., 2023.
|
|
91
|
+
|
|
92
|
+
1. “PEP 8 – Style Guide for Python Code.” [Online]. Available: https://peps.python.org/pep-0008/
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
## Getting started
|
|
97
|
+
|
|
98
|
+
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
|
99
|
+
|
|
100
|
+
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
|
101
|
+
|
|
102
|
+
## Add your files
|
|
103
|
+
|
|
104
|
+
* [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
|
105
|
+
* [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
|
|
106
|
+
|
|
107
|
+
```
|
|
108
|
+
cd existing_repo
|
|
109
|
+
git remote add origin https://ci.tno.nl/gitlab/STL/tailpype.git
|
|
110
|
+
git branch -M main
|
|
111
|
+
git push -uf origin main
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## Integrate with your tools
|
|
115
|
+
|
|
116
|
+
* [Set up project integrations](https://ci.tno.nl/gitlab/STL/tailpype/-/settings/integrations)
|
|
117
|
+
|
|
118
|
+
## Collaborate with your team
|
|
119
|
+
|
|
120
|
+
* [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
|
121
|
+
* [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
|
122
|
+
* [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
|
123
|
+
* [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
|
124
|
+
* [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
|
|
125
|
+
|
|
126
|
+
## Test and Deploy
|
|
127
|
+
|
|
128
|
+
Use the built-in continuous integration in GitLab.
|
|
129
|
+
|
|
130
|
+
* [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
|
|
131
|
+
* [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
|
132
|
+
* [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
|
133
|
+
* [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
|
134
|
+
* [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
|
135
|
+
|
|
136
|
+
***
|
|
137
|
+
|
|
138
|
+
# Editing this README
|
|
139
|
+
|
|
140
|
+
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
|
141
|
+
|
|
142
|
+
## Suggestions for a good README
|
|
143
|
+
|
|
144
|
+
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
|
145
|
+
|
|
146
|
+
## Name
|
|
147
|
+
Choose a self-explaining name for your project.
|
|
148
|
+
|
|
149
|
+
## Description
|
|
150
|
+
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
|
151
|
+
|
|
152
|
+
## Badges
|
|
153
|
+
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
|
154
|
+
|
|
155
|
+
## Visuals
|
|
156
|
+
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
|
157
|
+
|
|
158
|
+
## Installation
|
|
159
|
+
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
|
160
|
+
|
|
161
|
+
## Usage
|
|
162
|
+
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
|
163
|
+
|
|
164
|
+
## Support
|
|
165
|
+
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
|
166
|
+
|
|
167
|
+
## Roadmap
|
|
168
|
+
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
169
|
+
|
|
170
|
+
## Contributing
|
|
171
|
+
State if you are open to contributions and what your requirements are for accepting them.
|
|
172
|
+
|
|
173
|
+
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
|
174
|
+
|
|
175
|
+
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
|
176
|
+
|
|
177
|
+
## Authors and acknowledgment
|
|
178
|
+
Show your appreciation to those who have contributed to the project.
|
|
179
|
+
|
|
180
|
+
## License
|
|
181
|
+
For open source projects, say how it is licensed.
|
|
182
|
+
|
|
183
|
+
## Project status
|
|
184
|
+
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "tailpype"
|
|
3
|
+
version = "0.0.7"
|
|
4
|
+
authors = [
|
|
5
|
+
{ name="Pierre Paschinger", email="ppaschinger@gmx.at" },
|
|
6
|
+
]
|
|
7
|
+
description = "A toolbox for the analysis of emissions of internal combustion engines."
|
|
8
|
+
readme = "README.md"
|
|
9
|
+
requires-python = ">=3.12"
|
|
10
|
+
classifiers = [
|
|
11
|
+
"Programming Language :: Python :: 3",
|
|
12
|
+
"Operating System :: OS Independent",
|
|
13
|
+
]
|
|
14
|
+
license = "MIT"
|
|
15
|
+
license-files = ["LICEN[CS]E*"]
|
|
16
|
+
|
|
17
|
+
[project.urls]
|
|
18
|
+
Homepage = "https://test.pypi.org/manage/account/"
|
|
19
|
+
Issues = "https://test.pypi.org/manage/account/"
|
|
20
|
+
|
|
21
|
+
[tool.pytest.ini_options]
|
|
22
|
+
pythonpath = [
|
|
23
|
+
"src", "tailpipe"
|
|
24
|
+
]
|
tailpype-0.0.7/setup.cfg
ADDED
|
File without changes
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"""
|
|
2
|
+
The module 'read_write_spectra' provides functionality for reading and storing (infrared) spectra in different
|
|
3
|
+
formats. The focus lies on spectra that can be imported exported by the Calcmet software of Gasmet Technologies Oy.
|
|
4
|
+
"""
|
|
5
|
+
|
|
6
|
+
import os
|
|
7
|
+
import pandas as pd
|
|
8
|
+
|
|
9
|
+
from pathlib import Path
|
|
10
|
+
from typing import Literal, Union
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
def read_spectrum(file_path: str | os.PathLike[str],
|
|
14
|
+
file_extension: Literal['dx', 'txt']='dx') -> pd.DataFrame | None:
|
|
15
|
+
|
|
16
|
+
file_extension = os.path.splitext(os.path.basename(file_path))[1].lower()
|
|
17
|
+
# use lowercase to allow for unique check of file extension
|
|
18
|
+
|
|
19
|
+
if file_extension == '.dx':
|
|
20
|
+
|
|
21
|
+
print(f'\nReading spectra in DX-format is not yet implemented in tailpype !')
|
|
22
|
+
|
|
23
|
+
return pd.DataFrame()
|
|
24
|
+
|
|
25
|
+
elif file_extension == '.txt':
|
|
26
|
+
|
|
27
|
+
df_spectrum = pd.read_csv(filepath_or_buffer=file_path, sep=' ', header=None, encoding='ascii').\
|
|
28
|
+
rename(columns={0: 'Wave number [cm-1]', 1: os.path.splitext(os.path.basename(file_path))[0]})
|
|
29
|
+
|
|
30
|
+
else:
|
|
31
|
+
raise 'File type of spectrum file could not be determined'
|
|
32
|
+
|
|
33
|
+
return df_spectrum
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
def save_spectrum_as(df: pd.DataFrame, file_path: str | Path) -> None:
|
|
37
|
+
# https: // old.iupac.org / jcamp / protocols / dxir01.pdf
|
|
38
|
+
|
|
39
|
+
file_extension = os.path.splitext(os.path.basename(file_path))[1].lower()
|
|
40
|
+
# use lowercase to allow for unique check of file extension
|
|
41
|
+
|
|
42
|
+
if file_extension == '.dx':
|
|
43
|
+
|
|
44
|
+
# open templates of DX-file to be filled with data
|
|
45
|
+
with open(Path(os.path.join(Path(__file__).resolve().parent, 'templates', 'JCAMP‑DX template.dx'))) as fobj:
|
|
46
|
+
jcamp_dx_file = fobj.read()
|
|
47
|
+
|
|
48
|
+
df.iloc[:, 1] = df.iloc[:, 1] * 1e6
|
|
49
|
+
df.iloc[:, 1] = df.iloc[:, 1].round(0).astype(int)
|
|
50
|
+
# needed to match the number format
|
|
51
|
+
|
|
52
|
+
jcamp_dx_file = jcamp_dx_file.replace(r'REPLACE WITH DATA !', df.to_string(index=False, header=False))
|
|
53
|
+
|
|
54
|
+
with open(file_path, 'w') as fobj:
|
|
55
|
+
fobj.write(jcamp_dx_file)
|
|
56
|
+
|
|
57
|
+
return None
|
|
58
|
+
|
|
59
|
+
elif file_extension == '.txt':
|
|
60
|
+
|
|
61
|
+
print(f'\nStoring spectra in TXT-format is not yet implemented in tailpype !')
|
|
62
|
+
|
|
63
|
+
return None
|
|
File without changes
|
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: tailpype
|
|
3
|
+
Version: 0.0.7
|
|
4
|
+
Summary: A toolbox for the analysis of emissions of internal combustion engines.
|
|
5
|
+
Author-email: Pierre Paschinger <ppaschinger@gmx.at>
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://test.pypi.org/manage/account/
|
|
8
|
+
Project-URL: Issues, https://test.pypi.org/manage/account/
|
|
9
|
+
Classifier: Programming Language :: Python :: 3
|
|
10
|
+
Classifier: Operating System :: OS Independent
|
|
11
|
+
Requires-Python: >=3.12
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE.txt
|
|
14
|
+
Dynamic: license-file
|
|
15
|
+
|
|
16
|
+
# tailpype
|
|
17
|
+
|
|
18
|
+
## Table of Contents
|
|
19
|
+
- [Introduction](#introduction)
|
|
20
|
+
- [Getting started](#getting-started)
|
|
21
|
+
- [Building, uploading, and installing the package](#building-uploading-and-installing-the-package)
|
|
22
|
+
- [The modules](#the-modules)
|
|
23
|
+
- [engine](#engine)
|
|
24
|
+
- [ftir](#ftir)
|
|
25
|
+
- [read_meas](#read_meas)
|
|
26
|
+
- [Tests](#tests)
|
|
27
|
+
- [References](#references)
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## Introduction
|
|
39
|
+
|
|
40
|
+
## License
|
|
41
|
+
|
|
42
|
+
## Getting started
|
|
43
|
+
|
|
44
|
+
## Building, uploading, and installing the package
|
|
45
|
+
|
|
46
|
+
The steps needed to make a new build of a Python package, to upload it to (Test)PyPI, and to install it are described in this section. The information has been taken from the part 'Packaging Python Projects' of [1]. A sample Python project/package can be downloaded from [2]. This has not been done for tailpipe but the project structure has been studied as a reference.
|
|
47
|
+
First of all, it is a good idea to have the latest versions of pip (package manager) and twine (utility for publishing Python packages) installed. This can be achieved with the following commands:
|
|
48
|
+
```
|
|
49
|
+
py -m pip install --upgrade pip
|
|
50
|
+
py -m pip install --upgrade twine
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
To create a new build of the package, use
|
|
54
|
+
```
|
|
55
|
+
py -m build
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
To upload the build to (Test)PyPI, type
|
|
59
|
+
```
|
|
60
|
+
py -m twine upload --repository testpypi dist/*
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
You need an API token to finish this process. API tokens can be created in the account settings of your (Test)PyPI account. Logging in to the (Test)PyPI account requires two-factor authentication: the first is username/password, the second is the Authenticator app. If the error message below occurs, it might help to clear the 'dist' folder:
|
|
64
|
+
```
|
|
65
|
+
"ERROR HTTPError: 400 Bad Request from https://test.pypi.org/legacy/
|
|
66
|
+
File already exists. See https://test.pypi.org/help/#file-name-reuse for more information."
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
To install a build of the package example-package use
|
|
70
|
+
```
|
|
71
|
+
py -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-package
|
|
72
|
+
```
|
|
73
|
+
If a specific version, e.g., 1.2.3. is needed, use
|
|
74
|
+
```
|
|
75
|
+
py -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-package==1.2.3
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
If the package is located in PyPI, the usual way with using pip can also be used to install a build.
|
|
79
|
+
|
|
80
|
+
## The modules
|
|
81
|
+
|
|
82
|
+
### engine
|
|
83
|
+
|
|
84
|
+
### ftir
|
|
85
|
+
|
|
86
|
+
### read_meas
|
|
87
|
+
|
|
88
|
+
## Tests
|
|
89
|
+
|
|
90
|
+
## Release notes
|
|
91
|
+
|
|
92
|
+
- 0.0.1 - 0.0.x: Development builds to be published on TestPyPI
|
|
93
|
+
- 1.0.0: First build to be published on PyPI
|
|
94
|
+
|
|
95
|
+
## References
|
|
96
|
+
|
|
97
|
+
1. “Python Packaging User Guide.” Accessed: Mar. 10, 2026. [Online]. Available: https://packaging.python.org/en/latest/
|
|
98
|
+
|
|
99
|
+
1. “A sample Python project.” Accessed: Mar. 10, 2026. [Online]. Available: https://github.com/pypa/sampleproject
|
|
100
|
+
|
|
101
|
+
1. B. Klein, Einführung in Python 3: Für Ein- und Umsteiger, 4th ed. München,: Carl Hanser Fachbuchverlag, 2021.
|
|
102
|
+
|
|
103
|
+
1. B. Klein, Numerisches Python: Arbeiten mit NumPy, Matplotlib und Pandas. München,: Carl Hanser Fachbuchverlag, 2019.
|
|
104
|
+
|
|
105
|
+
1. D. Hillard, Publishing Python Packages: Test, Share, and Automate Your Projects. Shelter Island: Manning Publications Co., 2023.
|
|
106
|
+
|
|
107
|
+
1. “PEP 8 – Style Guide for Python Code.” [Online]. Available: https://peps.python.org/pep-0008/
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
## Getting started
|
|
112
|
+
|
|
113
|
+
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
|
114
|
+
|
|
115
|
+
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
|
116
|
+
|
|
117
|
+
## Add your files
|
|
118
|
+
|
|
119
|
+
* [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
|
120
|
+
* [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
cd existing_repo
|
|
124
|
+
git remote add origin https://ci.tno.nl/gitlab/STL/tailpype.git
|
|
125
|
+
git branch -M main
|
|
126
|
+
git push -uf origin main
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
## Integrate with your tools
|
|
130
|
+
|
|
131
|
+
* [Set up project integrations](https://ci.tno.nl/gitlab/STL/tailpype/-/settings/integrations)
|
|
132
|
+
|
|
133
|
+
## Collaborate with your team
|
|
134
|
+
|
|
135
|
+
* [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
|
136
|
+
* [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
|
137
|
+
* [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
|
138
|
+
* [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
|
139
|
+
* [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
|
|
140
|
+
|
|
141
|
+
## Test and Deploy
|
|
142
|
+
|
|
143
|
+
Use the built-in continuous integration in GitLab.
|
|
144
|
+
|
|
145
|
+
* [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
|
|
146
|
+
* [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
|
147
|
+
* [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
|
148
|
+
* [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
|
149
|
+
* [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
|
150
|
+
|
|
151
|
+
***
|
|
152
|
+
|
|
153
|
+
# Editing this README
|
|
154
|
+
|
|
155
|
+
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
|
156
|
+
|
|
157
|
+
## Suggestions for a good README
|
|
158
|
+
|
|
159
|
+
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
|
160
|
+
|
|
161
|
+
## Name
|
|
162
|
+
Choose a self-explaining name for your project.
|
|
163
|
+
|
|
164
|
+
## Description
|
|
165
|
+
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
|
166
|
+
|
|
167
|
+
## Badges
|
|
168
|
+
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
|
169
|
+
|
|
170
|
+
## Visuals
|
|
171
|
+
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
|
172
|
+
|
|
173
|
+
## Installation
|
|
174
|
+
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
|
175
|
+
|
|
176
|
+
## Usage
|
|
177
|
+
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
|
178
|
+
|
|
179
|
+
## Support
|
|
180
|
+
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
|
181
|
+
|
|
182
|
+
## Roadmap
|
|
183
|
+
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
184
|
+
|
|
185
|
+
## Contributing
|
|
186
|
+
State if you are open to contributions and what your requirements are for accepting them.
|
|
187
|
+
|
|
188
|
+
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
|
189
|
+
|
|
190
|
+
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
|
191
|
+
|
|
192
|
+
## Authors and acknowledgment
|
|
193
|
+
Show your appreciation to those who have contributed to the project.
|
|
194
|
+
|
|
195
|
+
## License
|
|
196
|
+
For open source projects, say how it is licensed.
|
|
197
|
+
|
|
198
|
+
## Project status
|
|
199
|
+
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
LICENSE.txt
|
|
2
|
+
README.md
|
|
3
|
+
pyproject.toml
|
|
4
|
+
src/tailpype/__init__.py
|
|
5
|
+
src/tailpype/example.py
|
|
6
|
+
src/tailpype/read_meas.py
|
|
7
|
+
src/tailpype.egg-info/PKG-INFO
|
|
8
|
+
src/tailpype.egg-info/SOURCES.txt
|
|
9
|
+
src/tailpype.egg-info/dependency_links.txt
|
|
10
|
+
src/tailpype.egg-info/top_level.txt
|
|
11
|
+
src/tailpype/ftir/__init__.py
|
|
12
|
+
src/tailpype/ftir/read_write_spectra.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
tailpype
|