kpindex
Very simple package for obtaining the planetary Kp index data (see https://www.gfz-potsdam.de/en/kp-index/ for more information)
Installation
This package depends on the following:
- numpy
- RecarrayTools
- PyFileIO
which are all available on PyPI.
Installation is simple and can be done in one of four ways:
Method 1
This method simply uses the Python pip3 command to download this
module and its dependencies:
pip3 install kpindex --user
Method 2
This method uses the Python wheel on the "releases" page of this
repository. Download the wheel, then isntall using pip3:
pip3 install kpindex-0.0.1-py3-none-any.whl --user
Method 3
Don't trust my prepackaged stuff? OK, clone this repository and build your own:
git clone https://github.com/mattkjames7/kpindex.git
cd kpindex
python3 setup.py bdist_wheel
pip3 install dist/kpindex-0.0.1-py3-none-any.whl --user
Method 4
So you don't like wheels? Fine. Clone the repository and just move the
"kpindex" folder to your $PYTHONPATH.
Post-Install
In order for the module to be able to download the Kp index data from
the FTP site, you will need to point it in the direction of a directory
where you have read and write access using the $KPDATA_PATH
environment variable. This can be done either by running the following
in the terminal before starting Python, or inserting it into your
~/.bashrc file:
export KPDATA_PATH=/path/to/the/data
Usage
Using this module is very simple: the first time you run it you will need to update the database (also when you think the database is out of date) e.g.
import kpindex
kpindex.UpdateLocalData()
It may take a couple of minutes to download the data and convert it, then you are ready to read the data:
data = kpindex.GetKp(Date)
where Date could be None, in which case ALL of the Kp indices ever
will be returned; Date could be a single date in the format yyyymmdd,
in which case only Kp indices fromt hat date will be returned; finally
it could be a two element array/list/tuple containing two dates, in this
case it will return all the indices from the start to the end date.
Enjoy!
Metadata
Release files for kpindex 2.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| kpindex-2.1.0-py3-none-any.whl | Python 3 | none | any | Details for kpindex-2.1.0-py3-none-any.whl |
Release files / kpindex-2.1.0-py3-none-any.whl
| Download URL | kpindex-2.1.0-py3-none-any.whl |
|---|---|
| Size | 13.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3eaade1c14ef6c648c6d555b40a1fab18cb22b217043af6308758572e87ceaea
|
|
BLAKE2b-256 checksum How to use checksums |
5ab0b46c203f8a0cb5822b300fd244bd549643c13b3f19081386efb2397a4a17
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.21
|
Security for kpindex 2.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.