Skip to main content

tsyganenko

Zenodo badge Tests badge

A Python wrapper for N. A. Tsyganenko’s field-line tracing routines.

For information on the models and routines that are wrapped by this package, please visit Empirical Magnetosphere Models by N. A. Tsyganenko.

Citation

When using this software, please cite the Zenodo record as well as citing the relevant papers.

Geopack and the other Fortran code in this repository are developed by N A Tsyganenko et al. and licenced under the GPL v3 or later.

The Python wrappers were originally written by Sebastien de Larquier in 2012. They are now maintained by John C Coxon. Small edits have been made to Geopack-2008.for to allow for f2py compilation. Code in this repository other than the original Fortran is licenced under the MIT licence.

Funding

John C Coxon was supported during this work by Science and Technology Facilities Council (STFC) Consolidated Grants ST/R000719/1 and ST/V000942/1, and Ernest Rutherford Fellowship ST/V004883/1.

Installation

pip install tsyganenko
pytest tests/test.py

Please note that at this time, Windows is not well-supported by this package; if you would like to help resolve this, please check out issue #15.

Tests take around 1 hour to run, so don’t be alarmed if you see this behaviour on your machine.

The tests are run against the csv files in the repository which were created on an Apple Silicon (M1) Mac. Compiling the package on other machines leads to disparities which reflect the change in underlying architecture rather than reflecting changes in code. As such, by default, tests.py is extremely permissive; it will test to a relative accuracy of 0.5 or an absolute accuracy of 10.0. If you want to run tests with the pytest defaults, run pytest tests/test_exact.py, and expect a large number of tests to fail unless you are running on an M1 chip.

Usage

To use this module, simply follow the example provided in the Trace object docstring.

from tsyganenko.trace import Trace
help(Trace)

Alternatively, there are example notebooks provided which can be used to explore what this module can do:

cd notebooks
jupyter notebook

Metadata

Release files for tsyganenko 2020.2.3

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

Source distribution (sdist)

Source distribution for tsyganenko 2020.2.3
File Size Uploaded Provenance Actions
tsyganenko-2020.2.3.tar.gz 407.1 kB With provenance Details for tsyganenko-2020.2.3.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for tsyganenko 2020.2.3
File Actions
tsyganenko-2020.2.3-cp313-cp313-musllinux_1_2_x86_64.whl CPython 3.13 CPython 3.13 Linux musl 1.2+ x86-64 Details for tsyganenko-2020.2.3-cp313-cp313-musllinux_1_2_x86_64.whl
tsyganenko-2020.2.3-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.13 CPython 3.13 Linux glibc 2.27+ x86-64, Linux glibc 2.28+ x86-64 Details for tsyganenko-2020.2.3-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
tsyganenko-2020.2.3-cp313-cp313-macosx_14_0_arm64.whl CPython 3.13 CPython 3.13 macOS 14.0+ ARM64 Details for tsyganenko-2020.2.3-cp313-cp313-macosx_14_0_arm64.whl
tsyganenko-2020.2.3-cp312-cp312-musllinux_1_2_x86_64.whl CPython 3.12 CPython 3.12 Linux musl 1.2+ x86-64 Details for tsyganenko-2020.2.3-cp312-cp312-musllinux_1_2_x86_64.whl
tsyganenko-2020.2.3-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.28+ x86-64, Linux glibc 2.27+ x86-64 Details for tsyganenko-2020.2.3-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
tsyganenko-2020.2.3-cp312-cp312-macosx_14_0_arm64.whl CPython 3.12 CPython 3.12 macOS 14.0+ ARM64 Details for tsyganenko-2020.2.3-cp312-cp312-macosx_14_0_arm64.whl

Total release size: 7.8 MB

Release files / tsyganenko-2020.2.3.tar.gz

Download URL tsyganenko-2020.2.3.tar.gz
Size 407.1 kB
Tags Source
SHA-256 checksum
How to use checksums
90d6a1bd0e34d5dbfebdb80070620573b8ef47192a77e8479cac7802f5116f86
BLAKE2b-256 checksum
How to use checksums
8672e03e2ec67817e14661d36c96e390e921f868c071d638a431533a4d8ab410
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 9, 2025.

Transparency log

Release files / tsyganenko-2020.2.3-cp313-cp313-musllinux_1_2_x86_64.whl

Download URL tsyganenko-2020.2.3-cp313-cp313-musllinux_1_2_x86_64.whl
Size 1.6 MB
Tags CPython 3.13 Linux musl 1.2+ x86-64
SHA-256 checksum
How to use checksums
3e36ade6e3b986d451f6e5871c66bd4eb4d5199d0f1bc30ef07ff221bac15fde
BLAKE2b-256 checksum
How to use checksums
730aaf79ed47e97ff4437b12396b194e021893304233cfe15df6573d26764c8e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 9, 2025.

Transparency log

Release files / tsyganenko-2020.2.3-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL tsyganenko-2020.2.3-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 1.3 MB
Tags CPython 3.13 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
4c5056d40cf2cde22a025684e20ff934c8cd734e16e3b9672ed17205de0959dd
BLAKE2b-256 checksum
How to use checksums
44e8f2df5fc25fd6ceca2457066a3b2eb466741954397e2325475b974512f632
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 9, 2025.

Transparency log

Release files / tsyganenko-2020.2.3-cp313-cp313-macosx_14_0_arm64.whl

Download URL tsyganenko-2020.2.3-cp313-cp313-macosx_14_0_arm64.whl
Size 866.4 kB
Tags CPython 3.13 macOS 14.0+ ARM64
SHA-256 checksum
How to use checksums
d2008c05f958e58abfc22cf62e25efa8e178baf13210a4bc45be5f4141da11a8
BLAKE2b-256 checksum
How to use checksums
48f3f08e78c3f492d9ef8c836b589c4388d307384444daf1b9b0bfe59984b574
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 9, 2025.

Transparency log

Release files / tsyganenko-2020.2.3-cp312-cp312-musllinux_1_2_x86_64.whl

Download URL tsyganenko-2020.2.3-cp312-cp312-musllinux_1_2_x86_64.whl
Size 1.6 MB
Tags CPython 3.12 Linux musl 1.2+ x86-64
SHA-256 checksum
How to use checksums
a6aca3aca69a90f33d34c79b31287aef510c057295d4cc37a5d7538b79276f95
BLAKE2b-256 checksum
How to use checksums
9a35bff476822d0f7af032ebc4fdc61cc0b1a5742feb6c37640cd01fb79e60b5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 9, 2025.

Transparency log

Release files / tsyganenko-2020.2.3-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl

Download URL tsyganenko-2020.2.3-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Size 1.3 MB
Tags CPython 3.12 Linux glibc 2.27+ x86-64 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
67f9f425c68e8acb5b00c1f28b8e82cb7e2fd59e47ad6e14cf40a02e229c645f
BLAKE2b-256 checksum
How to use checksums
366cca6c9da8b1b02795056c5be96a2fe0b5619efc63a287a66aae6cf42face4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 9, 2025.

Transparency log

Release files / tsyganenko-2020.2.3-cp312-cp312-macosx_14_0_arm64.whl

Download URL tsyganenko-2020.2.3-cp312-cp312-macosx_14_0_arm64.whl
Size 866.4 kB
Tags CPython 3.12 macOS 14.0+ ARM64
SHA-256 checksum
How to use checksums
8f3f71a5b5245c3dbbaf05e4fed4103ee5a809edbb17fa14add6b9e879384572
BLAKE2b-256 checksum
How to use checksums
f8f6d9ed32efd515f8200da81695cce1a0b827ff9d9e2a8bf783feddd02e0f74
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 9, 2025.

Transparency log

Security for tsyganenko 2020.2.3

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.

Full provenance

All 7 files in this release have been uploaded with provenance metadata.

Select from 7 files

Attestation for tsyganenko-2020.2.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 9, 2025.

Transparency log

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page