Skip to main content

facer-model

PyPI badge Zenodo badge Tests badge

Field-Aligned Currents Estimated from Reconnection (FACER) is a Python implementation of the Birkeland current model presented by Coxon et al. (2016), based on Milan (2013). It is a simple mathematical model of the region 1 and 2 Birkeland current system intensities for differing dayside and nightside magnetic reconnection rates, consistent with the expanding/contracting polar cap paradigm of solar wind-magnetosphere-ionosphere coupling.

Citations

When using this software, please cite the Zenodo record as well as the following two papers:

Funding

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

Installation

To install and test the model, simply type:

pip install facer-model
pytest tests/test.py

Usage

A very basic instantiation of the model can be seen below. For more examples, check out the notebooks in the repository, which explicitly detail how to use the model to replicate the results from the two papers which define the model.

from facer import Model

dayside_reconnection_rate = 50       # in kV
nightside_reconnection_rate = 50     # in kV
solar_radio_flux = 80                # in SFU
time = datetime.datetime(2010, 1, 1)
hemisphere = "north"
polar_cap_flux = 0.5                 # in GWb

model = Model(dayside_reconnection_rate,
              nightside_reconnection_rate,
              solar_radio_flux,
              time,
              hemisphere,
              polar_cap_flux)

Metadata

Release files for facer-model 1.0.8

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

Source distribution (sdist)

Source distribution for facer-model 1.0.8
File Size Uploaded Provenance Actions
facer_model-1.0.8.tar.gz 25.0 kB With provenance Details for facer_model-1.0.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for facer-model 1.0.8
File Interpreter ABI Platform Actions
facer_model-1.0.8-py3-none-any.whl Python 3 none any Details for facer_model-1.0.8-py3-none-any.whl

Total release size: 47.8 kB

Release files / facer_model-1.0.8.tar.gz

Download URL facer_model-1.0.8.tar.gz
Size 25.0 kB
Tags Source
SHA-256 checksum
How to use checksums
ae96f88a258a4be8c64639093bafe3f529920699e0ff4af7277500a85959d4cd
BLAKE2b-256 checksum
How to use checksums
a8f1086cf75ba115e5afd5c8be1bce740b0e43a0055d429e127b30e258aade6c
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 Jun 26, 2025.

Transparency log

Release files / facer_model-1.0.8-py3-none-any.whl

Download URL facer_model-1.0.8-py3-none-any.whl
Size 22.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0470e439ca57de7ff597c8896600aa2d19409ae4154d6df2f31b8558218a34cb
BLAKE2b-256 checksum
How to use checksums
6dffb6628c8027207d3d8b20d9d4022667da5ba8bd4dd0c4b413f7aa0c08959d
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 Jun 26, 2025.

Transparency log

Security for facer-model 1.0.8

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

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for facer_model-1.0.8.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 Jun 26, 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