jpkfile

jpkfile is a module for reading of data archives recorded with JPK Instruments. The project’s repository can be found here.

Install

You have the following three options to install jpkfile.

via pip

The simplest way, if you have internet access on the target device, is to install via pip. In a command line type:

$ pip install --user jpkfile

via source

You can also clone/download the source files from jpkfile’s project page. Navigate to your copy of the project folder in a command line and type:

$ python setup.py install --user

add module to your `PYTHONPATH`

Currently jpkfile has only one relevant python file jpkfile.py, which makes “installing” straight-forward: you simply need to add the folder in which the .py file lies to your python path. One way to do so is to add a .pth file containing the path to the folder as text to your user’s site-packages folder: * On my Ubuntu 18.04 machine, the site-packages folder is at /home/<username>/.local/lib/python3.7/site-packages * If yours isn’t there, you can figure it out by starting python in the command line and typing

>>> import site
>>> site.USER_SITE

Open a new file in a text editor, enter the path to the folder containing the jpkfile module.
Save the file into the site-packages folder.

That’s it. You should now be able to import jpkfile anywhere on your system.

First Steps

You can have a look at the read_data_from_jpk_archive.py file, or, if you have jupyter/ipython notebook installed, at the read_data_from_jpk_archive.ipynb file in the examples folder. Those examples show you first steps how to use the jpkfile module.

Documentation

The module is documented using sphinx. You can find a built version at readthedocs.io, and also download it as PDF or HTML from there. Alternatively, you can build it yourself locally. The source files include a docs folder, which contains all the contents for the documentation. It requires sphinx (I tested only version 2.0.1) and the sphinx_rtd_theme to build.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Release files for jpkfile 1.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jpkfile 1.6.1
File	Size	Uploaded
jpkfile-1.6.1.tar.gz	14.9 kB	Oct 23, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for jpkfile 1.6.1
File	Interpreter	ABI	Platform	Reset
jpkfile-1.6.1-py3-none-any.whl 14.1 kB Oct 23, 2020	Python 3	none	any	Details

Total release size: 29.0 kB

Release files / jpkfile-1.6.1.tar.gz

Download URL	jpkfile-1.6.1.tar.gz
Size	14.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`002787897e317a495319509502f064f1a30f2dbd97f3db4dbf4d5917563a0721`
BLAKE2b-256 checksum How to use checksums	`7c57b334276c72b6b3cd5c303b3b2e61d44d2f455e99fdaa41f3bb494737eeb7`
Upload date	Oct 23, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6`

Release files / jpkfile-1.6.1-py3-none-any.whl

Download URL	jpkfile-1.6.1-py3-none-any.whl
Size	14.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`849c94cf450a896b431c0a630a47a66bf524285836ddac9882408872768c2957`
BLAKE2b-256 checksum How to use checksums	`c555efa55a243ec54819b3fe78facf89ebdd6770f409391d9b497d01e9cd4a57`
Upload date	Oct 23, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6`